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: Generate AsyncAPI Documentation | |
| on: | |
| push: | |
| branches: | |
| - main # activate the workflow on push to the main branch | |
| jobs: | |
| documentation: | |
| runs-on: ubuntu-latest # choose the operating system for the job | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v2 # step to checkout the repository | |
| - name: Generate HTML documentation | |
| uses: asyncapi/[email protected] | |
| with: | |
| command: generate | |
| filepath: './asyncapi.yaml' # path to the AsyncAPI file | |
| template: '@asyncapi/[email protected]' # template for the documentation | |
| output: './generated-docs' # path to the folder where the documentation will be generated | |
| - name: Deploy to GitHub Pages | |
| uses: JamesIves/[email protected] | |
| with: | |
| branch: gh-pages # branch to deploy the documentation | |
| folder: generated-docs # folder with the generated documentation | |
| token: ${{ secrets.PERSONAL_ACCESS_TOKEN }} # GitHub token to authenticate the deployment |