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

app-state-diagram GitHub action
https://github.com/alps-asd/asd-action

api-docs gh-actions gh-pages

Last synced: 9 days ago
JSON representation

app-state-diagram GitHub action

• Host: GitHub
• URL: https://github.com/alps-asd/asd-action
• Owner: alps-asd
• License: mit
• Created: 2021-11-16T07:34:21.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-11-23T15:54:35.000Z (about 4 years ago)
• Last Synced: 2025-09-24T12:41:04.918Z (4 months ago)
• Topics: api-docs, gh-actions, gh-pages
• Homepage:
• Size: 350 KB
• Stars: 4
• Watchers: 4
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site). Make sure you set the source as `gh-pages` and `root (/)`.