Skip to content
anchor

GitHub Action

app-state-diagram

1.2.4 Latest version

app-state-diagram

anchor

app-state-diagram

Produces a full application state diagram and hyperlinked documentation from ALPS profile

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: app-state-diagram

              
  uses: alps-asd/[email protected]
Learn more about this action in alps-asd/asd-action

Choose a version

app-state-diagram action

This action generates ALPS app-state-diagram.

Inputs

config

Required A config file path. Default: "asd.xml"

profile

Required A profile file path. Default: "profile.xml"

Start from the skeleton

https://github.com/alps-asd/alps-skeleton

Manual Setup

  1. Save the following snippet as .github/workflows/asd.yml
  2. Create profile.xml and git push to GitHub

asd.yml

name: ASD documents

on: push

jobs:
  asd:
    runs-on: ubuntu-latest
    name: ASD documents
    steps:
      - name: Checkout
        uses: actions/checkout@v2

      - name: Generates ASD documents
        uses: alps-asd/asd-action@v1
        id: asd
        with:
          config: asd.xml
          profile: profile.xml

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ${{ steps.asd.outputs.dir}}
          destination_dir: ${{ steps.asd.outputs.dir}}

Each time you commit, the ASD documents will be generated in gh-pages.

Setup GH pages

Configuring a publishing source for your GitHub Pages site. Make sure you set the source as gh-pages and root (/).