https://github.com/devkanro/setup-statusfy

Manage your statusfy page by GitHub issues and actions
https://github.com/devkanro/setup-statusfy

Last synced: 5 days ago
JSON representation

Manage your statusfy page by GitHub issues and actions

• Host: GitHub
• URL: https://github.com/devkanro/setup-statusfy
• Owner: devkanro
• License: mit
• Created: 2021-01-22T16:50:49.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-05-15T17:09:29.000Z (over 3 years ago)
• Last Synced: 2024-10-30T00:31:37.584Z (16 days ago)
• Language: TypeScript
• Homepage:
• Size: 146 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# setup-statusfy

Manage your statusfy page by GitHub issues and actions

## Usage

See [action.yml](action.yml)

```yaml

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](https://github.com/devkanro/setup-statusfy-demo)  

See [The demo site](http://statusfy.higan.me)

## 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

```shell

> mkdir my-statusfy

```

2. Initialize statusfy

```shell

> npx statusfy init

```

3. NPM install

```shell

> npm install

```

4. Add **setup-statusfy** Action  

    Create `.github/workflows/statusfy.yml`

```yaml

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`

```yaml

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.

```Markdown

# 

```

8. Close issue to resolve the incident.