docs: update actions and workflows documentation #492
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Greetings | |
| # ========================== | |
| # Workflow to greet new contributors. | |
| # Mainly using [First Interaction Action](https://github.com/actions/first-interaction), 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. | |
| name: Greetings | |
| on: | |
| issues: | |
| types: [opened] | |
| pull_request_target: | |
| branches: [main] | |
| workflow_call: | |
| inputs: | |
| runs-on: | |
| description: "Json array of runner(s) to use. See <https://docs.github.com/en/actions/using-jobs/choosing-the-runner-for-a-job>." | |
| type: string | |
| default: '["ubuntu-latest"]' | |
| required: false | |
| issue-message: | |
| description: "Comment to post on an individual's first issue. See <https://github.com/actions/first-interaction#usage>." | |
| type: string | |
| required: false | |
| pr-message: | |
| description: "Comment to post on an individual's first pull request. See <https://github.com/actions/first-interaction#usage>." | |
| type: string | |
| required: false | |
| secrets: | |
| github-token: | |
| description: "Token for the repository. See <https://github.com/actions/first-interaction#usage>." | |
| permissions: | |
| contents: read | |
| issues: write | |
| pull-requests: write | |
| jobs: | |
| greeting: | |
| runs-on: ${{ inputs.runs-on && fromJson(inputs.runs-on) || 'ubuntu-latest' }} | |
| steps: | |
| - uses: actions/first-interaction@34f15e814fe48ac9312ccf29db4e74fa767cbab7 # v1.3.0 | |
| with: | |
| repo-token: ${{ secrets.github-token || github.token }} | |
| issue-message: ${{ inputs.issue-message || 'Hi, thank for reporting an issue, we will check it out very soon' }} | |
| pr-message: ${{ inputs.pr-message || 'Hi, thank you for creating your PR, we will check it out very soon' }} |