doc: announced dependencies reshuffle for v0.24.0 (#142) #1
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
| name: Webhook Announcements | |
| # invoke the common webhook-announcements workflow, scanning README. | |
| # | |
| # Two modes: | |
| # | |
| # * push: diff on "## Announcements" section exercises the | |
| # real before..after detection and post to discord channel. | |
| # | |
| # * workflow_dispatch: a manual live run. Optionally provide an arbitrary webhook URL and | |
| # it POSTs for real. By default it diffs against the git empty tree, so every | |
| # announcement currently in the fixture is posted — no need to craft a diff. | |
| # | |
| # NOTE: the webhook URL you type is a workflow_dispatch input and is therefore | |
| # visible in the run's UI/logs. Use a throwaway test webhook (and/or rotate it | |
| # afterwards), not the production go-openapi webhook. | |
| permissions: | |
| contents: read | |
| on: | |
| push: | |
| branches: | |
| - master | |
| paths: | |
| - 'README.md' | |
| workflow_dispatch: | |
| inputs: | |
| webhook-url: | |
| description: | | |
| Webhook URL to POST to (e.g. a test Discord channel webhook). | |
| Visible in run logs — use a throwaway webhook. | |
| type: string | |
| default: '' | |
| compare-base: | |
| description: | | |
| Git ref to diff the fixture against. The default empty-tree SHA posts | |
| every announcement currently in the fixture. | |
| type: string | |
| default: "" | |
| dry-run: | |
| description: | | |
| Print payloads instead of posting. | |
| type: choice | |
| options: | |
| - 'false' | |
| - 'true' | |
| default: 'false' | |
| jobs: | |
| announce: | |
| uses: go-openapi/ci-workflows/.github/workflows/webhook-announcements.yml@af4c93f45481ea7d24ac2a9858272cc03daf424e # v0.4.0 | |
| with: | |
| scanned-markdown: README.md | |
| # On push: normal before..after diff (empty | |
| # compare-base). On dispatch: honor the provided inputs. | |
| dry-run: ${{ github.event_name == 'workflow_dispatch' && inputs.dry-run || 'false' }} | |
| compare-base: ${{ github.event_name == 'workflow_dispatch' && inputs.compare-base || '' }} | |
| secrets: inherit |