-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c14ee65
commit 6be6dd2
Showing
1 changed file
with
29 additions
and
0 deletions.
There are no files selected for viewing
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
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 |