setup-statusfy

Manage your statusfy page by GitHub issues and actions

Usage

See action.yml

steps:
- uses: actions/checkout@v1
- name: Generate incident
  uses: devkanro/setup-statusfy@v1
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    branch: master

Demo

See The demo repository
See The demo site

Features

1. Manage labels of repository automatically.
   This action will auto generate labels for your statusfy repository.
2. Manage your incidents by GitHub issues.
   Use GitHub as GUI for editing statusfy pages.

Quick Start

1. Create a folder

> mkdir my-statusfy

2. Initialize statusfy

> npx statusfy init

3. NPM install

> npm install

4. Add setup-statusfy Action
   Create .github/workflows/statusfy.yml

name: "Statusfy Incident"
on:
  issue_comment:
  issues:
    types: [opened, edited, closed, reopened]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - name: Generate incident
      uses: devkanro/setup-statusfy@v1
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}
        branch: master
    - name: Build the static site.
      run: |
        npm install
        npm run generate
    - name: Publish the static site to GitHub Pages.
      uses: jamesives/github-pages-deploy-action@releases/v3
      with:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        BRANCH: gh-pages
        FOLDER: dist

5. Add deploy Action
   Create .github/workflows/deploy.yml

name: "Deploy Statusfy"
on:
  push:
    branches: ["master"]

jobs:
  github-pages:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Build the static site.
        run: |
          npm install
          npm run generate
      - name: Publish the static site to GitHub Pages.
        uses: jamesives/github-pages-deploy-action@releases/v3
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          BRANCH: gh-pages
          FOLDER: dist

6. Create incident issue
   Create a issue with severity: XXXX label and system: XXXX labels, this action will create a incident markdown file and commit it to configured branch.
7. Update incident
   Comment on issue will update the incident, you must be follow the update format.

# <!--Title here!!!-->
<!--Content here!!!-->

8. Close issue to resolve the incident.