A script runs weekly to automatically create changelog files for new pull requests. If needed, you can run the GitHub Action manually.

Step 1: Running the GitHub Action

1. Log in to GitHub and go to the Get new changelog entries GitHub Action.
2. Click the Run workflow button and enter the number of days for which you want to get changelog entries. If you leave the field blank, the workflow will get changelog entries from the past 8 days by default.
3. Click Run workflow.

The workflow will search for new changelog entries, and if any are found, it will create a branch, create draft files in the branch and create a draft pull request.

Step 2: Updating changelog entries

If a pull request was created, you can start working on the content of the changelog entries.

1. Check the files added in the PR, and make sure that none of them are already in an existing pull request. You can look for open changelog PRs using this filter.
2. If you have duplicate files in your PR, you can delete them from the branch.
3. Move the new files from the draft folder into the year’s folder, and make the necessary changes to the file’s content.
4. Once your changelog entries are completed, push your changes to the branch that was created by the GitHub Action.
5. Go to the pull request and click Ready for review, then send it to a reviewer or merge it.

Once the pull requets is merged, your new entries should be deployed and appear in the changelog.

Last updated: 12 October 2022