Skip to content

Commit

Permalink
job gh action for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
masechkacat committed Apr 28, 2024
1 parent c14ee65 commit 6be6dd2
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/asyncapi-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
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.GITHUB_TOKEN }} # GitHub token to authenticate the deployment

0 comments on commit 6be6dd2

Please sign in to comment.