@lagoni/gh-action-asyncapi-document-bump v1.1.0

GitHub action used to bump the AsyncAPI document version in similar fashion to semantic-release. It analyses the commit messages to figure out how to appropriately bump the AsyncAPI document version while following semver.

https://user-images.githubusercontent.com/13396189/178147591-3858bba5-2848-4cb3-b5d3-3e1bf39bc4e4.mp4

• Usage
  • Automated push to main
  • Through PR's
• Outputs
  • wasBumped
  • oldVersion
  • newVersion
• Customization
• Restrictions

Usage

You can use this action in different scenarios, below is a few use-cases.

Automated push to main

For each commit on the main branch, try make a bump release for service X. If there is any version

name: Bump AsyncAPI for X
on:
  push:
    branches:
      - main
jobs:
  bump:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v2
      - name: Automated Version Bump
        uses: jonaslagoni/gh-action-asyncapi-document-bump@main
        env:
          GITHUB_TOKEN: '${{ secrets.GH_TOKEN }}'
        with:
          path-to-asyncapi: ./x_asyncapi.json
          commit-message: 'chore(release): x-service v{{version}}'
          commit-release-commit-message-regex: 'chore\(release\): x-service v{{version}}'

Through PR's

For each commit on the main branch, check if we need to do a bump through a PR.

name: Bump AsyncAPI for X
on:
  push:
    branches:
      - main
jobs:
  bump:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v2
      - name: Automated Version Bump
        id: version_bump
        uses: jonaslagoni/gh-action-asyncapi-document-bump@main
        env:
          GITHUB_TOKEN: '${{ secrets.GH_TOKEN }}'
        with:
          path-to-asyncapi: ./x_asyncapi.json
          skip-tag: 'true'
          skip-commit: 'true'
          # Match commit message from PR creation, to know what commit are bump release. Match `commit-message` from PR creation.
          commit-release-commit-message-regex: 'chore\(release\): x-service v{{version}}'
      - if: steps.version_bump.outputs.wasBumped == 'true'
        name: Create Pull Request with bumped version
        uses: peter-evans/create-pull-request@v3
        with:
          token: '${{ secrets.GH_TOKEN }}'
          commit-message: 'chore(release): x-service v${{steps.version_bump.outputs.newVersion}}'
          committer: 'bot <bot@bot.com>'
          author: 'bot <bot@bot.com>'
          title: 'chore(release): x-service v${{steps.version_bump.outputs.newVersion}}'
          body: Version bump x-service
          branch: 'version-bump/v${{steps.version_bump.outputs.newVersion}}'

Outputs

The GitHub action support different outputs that can be used in other jobs to control or modify workflows.

wasBumped

Makes it possible to run conditional extra jobs depending on whether the AsyncAPI document version was bumped or not.

    - name: 'Automated Version Bump'
      id: version_bump
      uses: 'jonaslagoni/gh-action-asyncapi-document-bump@main'
      env:
        GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
    - if: steps.version_bump.outputs.wasBumped == 'true'
      name: This job is only run if the AsyncAPI document was bumped.

oldVersion

Access the old version of the AsyncAPI document before the version was bumped.

    - name: 'Automated Version Bump'
      id: version_bump
      uses: 'jonaslagoni/gh-action-asyncapi-document-bump@main'
      env:
        GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
    - if: steps.version_bump.outputs.wasBumped == 'true'
      name: Print the old version of the document
      run: |
        echo ${{steps.version_bump.outputs.oldVersion}}

newVersion

Access the new version of the AsyncAPI document after the version was bumped.

    - name: 'Automated Version Bump'
      id: version_bump
      uses: 'jonaslagoni/gh-action-asyncapi-document-bump@main'
      env:
        GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
    - if: steps.version_bump.outputs.wasBumped == 'true'
      name: Print the new version of the document
      run: |
        echo ${{steps.version_bump.outputs.newVersion}}

Customization

Restrictions

These are the current restrictions:

• Only support JSON format for the AsyncAPI document and not YAML.
• Cannot be triggered by nested references, as we only look for references in the AsyncAPI document.