GitHub Actions Generate

Introduction

Generate GitHub Actions & How to write a good actions .yml file.

Good Actions configuration file

Node.js project continuous integration:

name: CI

on:
  # allows to manually run the job at any time.
  workflow_dispatch:
  
  push:
    branches:
      - '**'
    # should excluding some file and dir, because the actions caused by these files are unnecessary.
    paths-ignore:
      - '**.md'
      - 'docs/**'

jobs:
  Runner:
    timeout-minutes: 10
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ ubuntu-latest, macOS-latest ]
        node-version: [ 12, 14, 16 ]
    steps:
      - name: Checkout Git Source
        uses: actions/checkout@v3

      - name: Setup Node.js
        uses: actions/setup-node@v3
        with:
          node-version: ${{ matrix.node-version }}

      - name: Install dependencies
        run: |
          npm i npm@6 -g
          npm i

      - name: Continuous integration
        run: npm run ci

      - name: Code coverage
        uses: codecov/codecov-action@v3.0.0
        with:
          token: ${{ secrets.CODECOV_TOKEN }}

Document build:

name: Docs Build

on:
  # allows to manually run the job at any time.
  workflow_dispatch:
  
  push:
    branches:
      - main
    # only execute when docs/** was modified.
    paths:
      - 'docs/**'

jobs:
  docs-build:
    timeout-minutes: 10
    runs-on: ubuntu-latest

    steps:
      - name: Checkout Git Source
        uses: actions/checkout@v3

      - name: Setup Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '16'

      - name: Install dependencies
        run: npm install ${docs build tool} -D

      - name: Build docs
        run: npm run docs:build

      - name: Deploy to GitHub Pages
        if: success()
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs_dist

WIP ...

Contributors

snapre

This project follows the git-contributor spec, auto updated at Fri Apr 29 2022 13:06:32 GMT+0800.