Skip to content

greetings.md

Latest commit

 

History

History
160 lines (112 loc) · 5.67 KB

greetings.md

File metadata and controls

160 lines (112 loc) · 5.67 KB

GitHub Reusable Workflow: Greetings

Greetings

Release License Stars PRs Welcome

Overview

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.

Permissions

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

Usage

name: Greetings
on:
  issues:
    types:
      - opened
  pull_request:
    types:
      - opened
    branches:
      - main
permissions: {}
jobs:
  greetings:
    uses: hoverkraft-tech/ci-github-common/.github/workflows/greetings.yml@71b85947453f32b5d147ff3ab37351439a92d840 # 0.34.2
    permissions: {}
    secrets:
      # Token for the repository.
      # See https://github.com/actions/first-interaction#usage.
      # Defaults to the GITHUB_TOKEN secret.
      github-token: ""
    with:
      # JSON array of runner(s) to use.
      # See https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job.
      #
      # Default: `["ubuntu-latest"]`
      runs-on: '["ubuntu-latest"]'

      # 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: Hi, thank for reporting an issue, we will check it out very soon

      # 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: Hi, thank you for creating your PR, we will check it out very soon

Inputs

Workflow Call Inputs

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

Secrets

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

Contributing

Contributions are welcome! Please see the contributing guidelines for more details.

License

This project is licensed under the MIT License.

SPDX-License-Identifier: MIT

Copyright © 2026 hoverkraft-tech

For more details, see the license.

This documentation was automatically generated by CI Dokumentor.