lvjiaxuan / github-action-templates

My frequently used GitHub action templates.

Workflow Templates

1. lvr-release
2. lvr-publish
3. update-deps

Usage

Release and Publish are usually used together.

Based on my own release tool.

1. The release workflow resolves release's notes from CHANGELOG.md.
2. The publish workflow supports syncing published pkgages to cnpm.

name: Release and Publish 

on:
  push:
    tags:
      - v*

jobs:
  release:
    permissions:
      contents: write
    uses: lvjiaxuan/github-action-templates/.github/workflows/lvr-release.yml@main
    secrets: inherit

  publish:
    uses: lvjiaxuan/github-action-templates/.github/workflows/lvr-publish.yml@main
    with:
      sync_cnpm: true
    secrets: inherit

Update dependencies

Ways of defining the user's email, which is a required param.

1. A hard code on inputs. Recommend using GitHub's noreply email.
2. If no inputs.email is provided, auto-detect vars.ACTOR_EMAIL by default. Reference to actions secrets and variables 👉 https://github.com/{actor}/{repo}/settings/secrets/actions .

Tip

👉 cron syntax help

name: Update Dependencies

permissions:
  pull-requests: write
  contents: write

on:
  workflow_dispatch: {}
  schedule:
    - cron: 0 0 * * SAT

jobs:
  update-deps:
    uses: lvjiaxuan/github-action-templates/.github/workflows/update-deps.yml@main
    with:
      email: [e-mail] # Explicitly set `inputs.email`, if `vars.ACTOR_EMAIL` isn't set.

more inputs

Other recommended actions

1. update-repository-description by @zhengbangbo