Skip to content

Commit

Permalink
DOC: Updates to how changelog generator is working (#1851)
Browse files Browse the repository at this point in the history
  • Loading branch information
sappelhoff authored Jun 13, 2024
1 parent a981535 commit da7ee9e
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 14 deletions.
15 changes: 5 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -721,17 +721,12 @@ The decision-making rules are outlined in

The changelog (see `src/CHANGES.md`) is generated automatically using
[github-changelog-generator](https://github.com/github-changelog-generator/github-changelog-generator).
You can see the workflow in the CircleCI configuration file (`.circleci/config.yml`).
You can see the workflow in the following GitHub Actions configuration file: `.github/workflows/changelog_generator.yml`.

As it stands, the changelog is generated whenever a pull request is integrated into
the `master` branch of the specification via a "Merge commit"
(as opposed to "Squash and merge" or "Rebase and merge";
see the [GitHub help page](https://help.github.com/en/articles/about-merge-methods-on-github)
for more information on merge methods).

![merge-commit](release_images/merge_commit.png "merge-commit")

Note that for pull requests starting with `REL:`, no changelog is generated.
This workflow is triggered for every commit to `master` that contains string `[build changelog]` in its commit message.
If you push several commits at once, you need to make sure that the "youngest commit" (the HEAD commit) contains that string.
The workflow will then open a Pull Request to incorporate the updated changelog.
Check the proposed changes and merge the Pull Request at will.

To exclude pull requests from showing up in the changelog, they have to be labeled with
the "exclude-from-changelog" label.
Expand Down
4 changes: 0 additions & 4 deletions Release_Protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,6 @@ your fork locally to a directory called `bids-specification`.

Before you start a release, you have to ensure that the automatically generated changelog is **up to date**.
See the relevant [section in CONTRIBUTING.md](CONTRIBUTING.md#how-is-the-changelog-generated) for further information.
In practice this means ensuring that the most recently merged pull request
was merged into the `master` branch using the "Merge commit" option.

![merge-commit](release_images/merge_commit.png.png "merge-commit")

### 1. Fetch the latest version of the [master branch of the BIDS-specification](https://github.com/bids-standard/bids-specification/tree/master)

Expand Down

0 comments on commit da7ee9e

Please sign in to comment.