AsyncAPI Conference

Online Edition

29th of October, 2025 | AsyncAPI YouTube

54 days until the end of Call for Speakers

Automate using GitHub Actions

Generate docs and code on your GitHub Actions pipeline.

Generate docs

Seamlessly integrate the docs generation process with your GitHub pipeline. Make sure your documentation is always up to date. It will be a gift to your team and your future self.

1name: AsyncAPI documents processing
2
3on:
4  push:
5    branches: [ master ]
6
7jobs:
8  generate:
9    runs-on: ubuntu-latest
10    steps:
11      - name: Checkout repo
12        uses: actions/checkout@v2
13
14      - name: Generating HTML from my AsyncAPI document
15        uses: asyncapi/github-action-for-generator
16
17      - name: Deploy GH page
18        uses: JamesIves/github-pages-deploy-action
19        with:
20          ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
21          BRANCH: gh-pages
22          FOLDER: generated-html