Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CHANGELOG workflow #1467

Merged
merged 10 commits into from
Oct 14, 2023
60 changes: 60 additions & 0 deletions .github/workflows/update-changelog.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: "[Release] Update CHANGELOG.md"
on:
release:
types: [released]
permissions:
contents: write
pull-requests: write
jobs:
setup:
# this workflow will always fail in forks; bail if this isn't running in the upstream
if: github.repository == 'awslabs/amazon-eks-ami'
runs-on: ubuntu-latest
outputs:
tag_name: ${{ steps.variables.outputs.tag_name }}
steps:
- id: variables
run: |
echo "tag_name=$(echo ${{ github.ref }} | cut -d/ -f3)" >> $GITHUB_OUTPUT
update-changelog:
runs-on: ubuntu-latest
needs:
- setup
steps:
- uses: actions/checkout@v3
with:
repository: awslabs/amazon-eks-ami
ref: refs/heads/master
path: amazon-eks-ami/
- uses: actions/github-script@v6
with:
script: |
const fs = require('fs');
const changelogPath = './amazon-eks-ami/CHANGELOG.md';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should verify that the changelog doesn't already have the release before we add it to ensure that this workflow is idempotent. If it fails, we'd ideally open a github issue.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a check for the release title. We'll get an email if this workflow fails, I could open an issue if you feel strongly about it

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not really. I think that the changelog has limited value, if any, since it's already in the release notes and now it's just a formatted list of commits and version information.

const placeholder = '<!--new-changelog-entry-placeholder-->';
const tagName = '${{ needs.setup.outputs.tag_name }}';
const release = await github.rest.repos.getReleaseByTag({
tag: tagName,
owner: context.repo.owner,
repo: context.repo.repo,
});
const changelog = fs.readFileSync(changelogPath, 'utf8');
if (changelog.includes(release.data.name)) {
throw new Error(`changelog already includes ${release.data.name}`);
}
const newEntry = `### ${release.data.name}\n${release.data.body}`;
const updatedChangelog = changelog.replace(placeholder, placeholder + '\n\n' + newEntry);
fs.writeFileSync(changelogPath, updatedChangelog);
- uses: peter-evans/create-pull-request@v4
with:
branch: update-changelog
path: amazon-eks-ami/
add-paths: CHANGELOG.md
commit-message: "Update CHANGELOG.md for release ${{ needs.setup.outputs.tag_name }}"
committer: "GitHub <noreply@github.com>"
author: "GitHub <noreply@github.com>"
title: "Update CHANGELOG.md"
labels: |
changelog/exclude
body: |
Adds CHANGELOG.md entry for release [${{ needs.setup.outputs.tag_name }}](https://github.com/awslabs/amazon-eks-ami/releases/tag/${{ needs.setup.outputs.tag_name }}).