Merge pull request #1908 from bids-standard/pre-commit-ci-update-config #68
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| --- | |
| name: GitHub_Changelog_Generator | |
| on: | |
| push: | |
| branches: ["master"] | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| github_changelog_generator: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Ruby | |
| uses: ruby/setup-ruby@v1 | |
| with: | |
| ruby-version: '3.2' | |
| - name: Install dependencies | |
| run: | | |
| gem install github_changelog_generator | |
| - name: Check version | |
| run: | | |
| github_changelog_generator --version | |
| - name: Build changelog | |
| run: | | |
| mkdir ~/changelog_build | |
| github_changelog_generator \ | |
| --exclude-tags-regex "^(?!v).*?$" \ | |
| --user bids-standard \ | |
| --project bids-specification \ | |
| --token ${{ secrets.GITHUB_TOKEN }} \ | |
| --output ~/changelog_build/CHANGES.md \ | |
| --header-label "# Changelog" \ | |
| --release-branch master \ | |
| --no-issues \ | |
| --no-filter-by-milestone \ | |
| --no-compare-link \ | |
| --pr-label "" \ | |
| --enhancement-label "" \ | |
| --bugs-label "" \ | |
| --exclude-labels "exclude-from-changelog" | |
| - name: Append changelog from pre-GitHub times | |
| run: | | |
| cat ${{ github.workspace }}/src/pregh-changes.md >> ~/changelog_build/CHANGES.md | |
| - name: Remove the inserted advert from the file | |
| run: | | |
| sed -i '/This Changelog was automatically generated by/d' ~/changelog_build/CHANGES.md | |
| - name: Print out complete changelog | |
| run: | | |
| cat ~/changelog_build/CHANGES.md | |
| - name: Archive changelog | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: changelog_pre_lint | |
| path: | | |
| ~/changelog_build/CHANGES.md | |
| lint_generated_changelog: | |
| needs: github_changelog_generator | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Download previously build changelog | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: changelog_pre_lint | |
| path: ~/changelog_build | |
| - name: Set up Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20 | |
| - name: Install remark and extensions | |
| run: | | |
| npm install `cat npm-requirements.txt` | |
| - name: Remark on autogenerated CHANGES.md | |
| # first remove empty lines | |
| # then run remark to re-organize | |
| # replace remark's bullet list "*" with "-" | |
| # final run of remark to check everything passes now | |
| run: | | |
| head -n 25 ~/changelog_build/CHANGES.md | |
| sed -i '/^$/d' ~/changelog_build/CHANGES.md | |
| echo $'\n------------------------------\n' | |
| head -n 25 ~/changelog_build/CHANGES.md | |
| npx remark ~/changelog_build/CHANGES.md --rc-path ${{ github.workspace }}/.remarkrc --output ~/changelog_build/CHANGES.md --quiet | |
| echo $'\n------------------------------\n' | |
| head -n 25 ~/changelog_build/CHANGES.md | |
| sed -i 's/^* /- /' ~/changelog_build/CHANGES.md | |
| echo $'\n------------------------------\n' | |
| head -n 25 ~/changelog_build/CHANGES.md | |
| npx remark ~/changelog_build/CHANGES.md --rc-path ${{ github.workspace }}/.remarkrc --frail --quiet --no-stdout | |
| - name: Archive linted changelog | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: changelog_post_lint | |
| path: | | |
| ~/changelog_build/CHANGES.md | |
| commit_generated_changelog: | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| needs: lint_generated_changelog | |
| # Run only if the head commit message contains "[build changelog]"" | |
| if: contains(github.event.head_commit.message, '[build changelog]') | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Download previously build changelog | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: changelog_post_lint | |
| path: ~/changelog_build | |
| - name: add changelog to git | |
| run: | | |
| mv ~/changelog_build/CHANGES.md ${{ github.workspace }}/src/CHANGES.md | |
| git config credential.helper 'cache --timeout=120' | |
| git config user.email "bids.maintenance@gmail.com" | |
| git config user.name "bids-maintenance" | |
| git add ${{ github.workspace }}/src/CHANGES.md | |
| git commit -m "[DOC] Auto-generated changelog entry" | |
| - name: Create Pull Request | |
| uses: peter-evans/create-pull-request@v6 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| branch: changelog_generator_update | |
| delete-branch: true | |
| title: '[DOC] Auto-generated changelog entry' | |
| labels: | | |
| exclude-from-changelog | |
| draft: false |