docs: add simple commands and more features to media-player entity (#36) #69
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: AsyncAPI | |
on: | |
push: | |
paths: | |
- 'dock-api/**' | |
- 'core-api/websocket/**' | |
- 'integration-api/**' | |
- '.github/workflows/asyncapi.yml' | |
pull_request: | |
types: [ opened, synchronize, reopened ] | |
paths: | |
- 'dock-api/**' | |
- 'core-api/websocket/**' | |
- 'integration-api/**' | |
- '.github/workflows/asyncapi.yml' | |
jobs: | |
validate: | |
name: Validate AsyncAPI | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
- name: Validate websocket-api | |
uses: WaleedAshraf/asyncapi-github-action@v0.0.10 | |
with: | |
filepath: './core-api/websocket/UCR2-asyncapi.yaml' | |
- name: Validate integration-api | |
uses: WaleedAshraf/asyncapi-github-action@v0.0.10 | |
with: | |
filepath: './integration-api/asyncapi.yaml' | |
- name: Validate dock-api | |
uses: WaleedAshraf/asyncapi-github-action@v0.0.10 | |
with: | |
filepath: './dock-api/UCD2-asyncapi.yaml' | |
- name: Prepare AsyncAPI html output | |
run: | | |
mkdir -p ./static/api/ws ./static/api/integration ./static/api/dock | |
- name: Install AsyncAPI generator | |
run: | | |
if [[ ! -x "$(command -v ag)" ]]; then | |
echo "AsyncAPI generator (ag) not found, installing it with npm" | |
sudo npm install -g @asyncapi/html-template@0.28.4 | |
sudo npm install -g @asyncapi/generator@1.10.14 | |
fi; | |
ag --version | |
- name: Generate core AsyncAPI HTML doc | |
run: | | |
ag ./core-api/websocket/UCR2-asyncapi.yaml @asyncapi/html-template -o ./static/api/ws --force-write | |
- name: Generate integration AsyncAPI HTML doc | |
run: | | |
ag ./integration-api/asyncapi.yaml @asyncapi/html-template -o ./static/api/integration --force-write | |
- name: Generate dock AsyncAPI HTML doc | |
run: | | |
ag ./dock-api/UCD2-asyncapi.yaml @asyncapi/html-template -o ./static/api/dock --force-write | |
- name: Deploy core API GH page | |
uses: JamesIves/github-pages-deploy-action@v4.5.0 | |
with: | |
branch: gh-pages | |
folder: ./static/api/ws | |
target-folder: ./ws | |
- name: Deploy integration API GH page | |
uses: JamesIves/github-pages-deploy-action@v4.5.0 | |
with: | |
branch: gh-pages | |
folder: ./static/api/integration | |
target-folder: ./integration | |
- name: Deploy dock API GH page | |
uses: JamesIves/github-pages-deploy-action@v4.5.0 | |
with: | |
branch: gh-pages | |
folder: ./static/api/dock | |
target-folder: ./dock |