diff --git a/.github/workflows/release-published.yml b/.github/workflows/update-changelog.yml similarity index 79% rename from .github/workflows/release-published.yml rename to .github/workflows/update-changelog.yml index e7d2349..1c19f68 100644 --- a/.github/workflows/release-published.yml +++ b/.github/workflows/update-changelog.yml @@ -1,15 +1,17 @@ -name: 'Release Published' +name: 'Update Changelog' on: pull_request: types: [closed] + release: + types: [published] permissions: contents: write jobs: push-updated-changelog: - if: github.event.pull_request.merged == true + if: github.event.pull_request.merged == true || github.event_name == 'release' name: "Update Changelog" runs-on: ubuntu-latest @@ -35,8 +37,8 @@ jobs: run: | make generate_changelog - - uses: stefanzweifel/git-auto-commit-action@v5 + - name: 'Push Changes' + uses: stefanzweifel/git-auto-commit-action@v5 with: commit_message: 'Update Changelog !automated' branch: master - commit_user_name: '[AI] The Red Queen' diff --git a/STYLEGUIDE.md b/STYLEGUIDE.md index c1977e8..0d51bd0 100644 --- a/STYLEGUIDE.md +++ b/STYLEGUIDE.md @@ -21,19 +21,8 @@ cluttersome. Introducing sub-directories should be thoughtfully planned, and dis ## CHANGELOG -The CHANGELOG is automatically generated with the command: - -```bash -make generate_changelog -``` - -Always, always, **always** make sure to do this as the last step before requesting a -PR review. Any PR where the CHANGELOG isn't updated should have that change requested -by reviewers. - -**! Note:** For best results, run the command and commit the change after opening a draft -PR, or after marking your PR ready for review. This seems to produce the most accurate -results in the log. +The CHANGELOG is automatically generated when a PR is merged to `master`, or a new +release is published. Don't worry about updating it manually. ## Pull-Request Naming