Giters

hamishwillee / workflows

Reusable GitHub Actions workflows

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

workflows

Reusable GitHub Actions workflows.

Available actions

auto-merge

The auto-merge reusable action is located in .github/workflows/auto-merge.yml. To use it you will need a Personal Access Token with the following scopes:

  • repo for private repositories
  • public_repo for public repositories

In the repository that will call this action, you need to define a secret named GH_TOKEN with the value of your Personal Access Token.

This reusable action depends on the following actions:

Usage

In the repository that will call this action, you will need to add a .github/workflows/auto-merge.yml file with the following content:

name: "auto-merge"
on: [pull_request_target]

jobs:
  auto-merge:
    uses:  mdn/workflows/.github/workflows/auto-merge.yml@main
    secrets:
      GH_TOKEN: ${{ secrets.GH_TOKEN }}

pr-rebase-needed

The pr-rebase-needed reusable action is located in .github/workflows/pr-rebase-needed.yml.

This reusable action depends on the following actions:

Inputs

The action has the following inputs:

label

If your repository uses a label named anything other than rebase needed 🚧 (for example, the repository may use merge conflicts), you can set the label here.

  • This input is optional with a default of rebase needed :construction:

comment

When a rebase is needed, the action will write a comment on the pull request to let the PR author know there are merge conflicts. This can be changed to whatever the repository desires, or left blank if no comment should be added.

  • This input is optional with a default of "This pull request has merge conflicts that must be resolved before we can merge this."

Secrets

This action requires the following secrets to be passed by the caller. These need to be set as environmental secrets using the calling repositories settings.

GH_TOKEN

Personal access token passed from the caller workflow. Read the documentation on creating a PA token.

Usage

In the repository that will call this action, you will need to add a .github/workflows/pr-rebase-needed.yml file with the following content:

With defaults

name: "PR Needs Rebase"

on:
  push:
  pull_request_target:
    types: [synchronize]

jobs:
  pr-needs-rebase:
    uses: mdn/workflows/.github/workflows/pr-needs-rebase.yml@main
    secrets:
      GH_TOKEN: ${{ secrets.GH_TOKEN }}

Overriding some defaults

name: "PR Needs Rebase"

on:
  push:
  pull_request_target:
    types: [synchronize]

jobs:
  pr-needs-rebase:
    uses: mdn/workflows/.github/workflows/pr-needs-rebase.yml@main
    with:
      label: "rebase needed :construction:"
    secrets:
      GH_TOKEN: ${{ secrets.GH_TOKEN }}

idle-issues

The idle-issues reusable action is located in .github/workflows/idle-issues.yml.

This reusable action depends on the following actions:

Inputs

The action has the following inputs:

label

If your repository uses a label named anything other than 🐌 idle (for example, the repository may want to use use stale), you can set the label here.

  • This input is optional with a default of 🐌 idle

comment

When the issue or pull request becomes stale, the action will write a comment on the pull request to let the author know. This can be changed to whatever the repository desires, or left blank if no comment should be added. If closure-days is set, this is highly recommended to ensure the author knows their issue or PR will be closed.

  • This input is optional with a default of an empty string

stale-days

The number of days before the issue or pull request is considered idle and the label and/or comment is applied.

  • This input is optional with a default of 37

closure-days

The number of days before the idle issue or pull request is closed. Set to -1 to disable.

  • This input is optional with a default of -1

Secrets

This action requires the following secrets to be passed by the caller. These need to be set as environmental secrets using the calling repositories settings.

GH_TOKEN

Personal access token passed from the caller workflow. Read the documentation on creating a PA token.

Usage

In the repository that will call this action, you will need to add a .github/workflows/mark-as-idle.yml file with the following content:

With defaults

name: "PR Needs Rebase"

on:
  push:
  pull_request_target:
    types: [synchronize]

jobs:
  mark-as-idle:
    uses: mdn/workflows/.github/workflows/mark-as-idle.yml@main
    secrets:
      GH_TOKEN: ${{ secrets.GH_TOKEN }}

Overriding some defaults

name: "PR Needs Rebase"

on:
  push:
  pull_request_target:
    types: [synchronize]

jobs:
  mark-as-idle:
    uses: mdn/workflows/.github/workflows/mark-as-idle.yml@main
    with:
      label: "rebase needed :construction:"
    secrets:
      GH_TOKEN: ${{ secrets.GH_TOKEN }}

publish-release

The publish-release GitHub Action automates publication of a new release on GitHub, updates the changelog and also publishes to the NPM registry.

NOTE: For the release-please workflow to work effectively, you need to follow the conventional commits conventions as detailed here. You can also find additional documentation on the GitHub Actions README.

This reusable action depends on the following actions:

Inputs

The action has the following inputs:

release-type

This is can be one of the release types as detailed in the release please docs.

  • This input is optional with a default of node

node-version

The version of Node.js to use for the release. This action supports all active and maintenance releases of Node.js.

  • This input is optional with a default of 12

npm-publish

Whether to publish the package to the NPM registry.

  • This input is optional with a default of true

npm-publish-args

Arguments to pass to the npm publish command. This is ignored if npm-publish is set to false.

  • This input is optional with a default of an empty string

registry-url

The registry to publish to.

  • This input is optional with a default of https://registry.npmjs.org

Secrets

This action requires the following secrets to be passed by the caller. Both of these need to be set as environmental secrets using the calling repositories settings.

GH_TOKEN

Personal access token passed from the caller workflow. Read the documentation on creating a PA token.

NPM_AUTH_TOKEN

Authentication token for the NPM registry. Read the documentation for details on creating a token.

Usage

In the repository that will call this action, you will need to add a .github/workflows/publish-release.yml file with the following content:

With defaults

name: publish-release

on:
  push:
    branches:
      - main

jobs:
  publish-release:
    uses:  mdn/workflows/.github/workflows/publish-release.yml@main
    secrets:
      GH_TOKEN: ${{ secrets.GH_TOKEN }}
      NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

Overriding some defaults

name: publish-release

on:
  push:
    branches:
      - main

jobs:
  publish-release:
    uses:  mdn/workflows/.github/workflows/publish-release.yml@main
    with:
      release-type: python
    secrets:
      GH_TOKEN: ${{ secrets.GH_TOKEN }}
      NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

Skip NPM publishing

name: publish-release

on:
  push:
    branches:
      - main

jobs:
  publish-release:
    uses:  mdn/workflows/.github/workflows/publish-release.yml@main
    with:
      npm-publish: false
    secrets:
      GH_TOKEN: ${{ secrets.GH_TOKEN }}

About

Reusable GitHub Actions workflows

License:Mozilla Public License 2.0