Skip to content

Latest commit

 

History

History
88 lines (66 loc) · 3.49 KB

greetings.md

File metadata and controls

88 lines (66 loc) · 3.49 KB

GitHub Reusable Workflow: Greetings

Workflow to greet new contributors. Mainly using First Interaction Action, with some opinionated defaults.

  • On issue creation, a comment is added to the issue.
  • On first contribution, a comment is added to the pull request.

Usage

name: Greetings

on:
  issues:
    types: [opened]
  pull_request_target:
    branches: [main]

permissions:
  contents: read
  issues: write
  pull-requests: write

jobs:
  greetings:
    uses: hoverkraft-tech/ci-github-common/.github/workflows/[email protected]
    secrets:
      # Token for the repository.
      # See https://github.com/actions/first-interaction#usage
      # Default GITHUB_TOKEN
      github-token: ""

    # Optional customizations.
    with:
      # Comment to post on an individual's first issue.
      # See https://github.com/actions/first-interaction#usage
      # Default: "Hi, thank for reporting an issue, we will check it out very soon"
      issue-message: ""
      # Comment to post on an individual's first pull request.
      # See https://github.com/actions/first-interaction#usage
      # Default: "Hi, thank you for creating your PR, we will check it out very soon"
      pr-message: ""

Secrets

Secret Description Default Required
github-token Token for the repository. See https://github.com/actions/first-interaction#usage. GITHUB_TOKEN false

Inputs

Input Description Default Type Required
runs-on Json array of runner(s) to use. See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job. ["ubuntu-latest"] string false
issue-message Comment to post on an individual's first issue. See https://github.com/actions/first-interaction#usage. Hi, thank for reporting an issue, we will check it out very soon string false
pr-message Comment to post on an individual's first pull request. See https://github.com/actions/first-interaction#usage. Hi, thank you for creating your PR, we will check it out very soon string false