action "Build" {
  uses = "palmerhq/changecast@v1.0.0"
  env = {
    DEPLOY_URL = {DEPLOY_URL}
  }
  secrets = [
    "GITHUB_TOKEN",
  ]
}

Note that URL is necessary for SEO and Open Graph tags to work properly, but ChangeCast will build without it. You can skip this for your first deployment, and redeploy once you know the deployment URL.

In the example below we are using Netlify, but any static deployment action should work. Simply configure the action to deploy the ./changecast directory that is created by the ChangeCast Action.

action "Publish with Netlify" {
  needs = "Build"
  uses = "netlify/actions/cli@master"
  args = "deploy --dir=./changecast --prod"
  secrets = [
    "NETLIFY_AUTH_TOKEN",
    "NETLIFY_SITE_ID",
  ]
}

Note that you can generate a new NETLIFY_SITE_ID by installing the Netlify CLI and running netlify sites:create.

As a bonus you can also try the Chronicler Action to help you draft release notes from PR titles.

For a full working example of deploying ChangeCast using Github Actions, check out our main.workflow.

You will be prompted for the following information:

• Github repository url: Enter the url of a Github repository (e.g. https://github.com/facebook/react).
• Github access token (optional for public repos): Generate and enter an access token with repo scope.

After deploying, you can assign a custom domain for your changelog using Netlify.

In order to rebuild whenever a Github release is published, we want to add a webhook for Github releases to Netlify. The steps to do so are:

1. In your Netlify site's "Build & deploy" settings, find the "Github Releases" build hook and copy the URL displayed.
2. Create a webhook in the Github repository (https://github.com/{owner}/{name}/settings/hooks/new).
3. Paste the URL from step 1 into the Github webhook's "Payload URL".
4. In the Github webhook under "Which events would you like to trigger this webhook?", select "Let me select individual events." and "Releases".

You're all set! Now your changelog page and widget will rebuild whenever a new release is published.