ci: add a skeleton github actions workflow for downstream projects #153
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is one idea to start a CI suite for downstream tests, see the conversation at #141.
The goal here is to have a skeleton workflow that can be manually inspected by the maintainers and merged onto
master
. Once this file is onmaster
, then subsequent PRs that modify the workflow file will (unless configured otherwise) run the workflow on the PR, which is the end goal of #141.This workflow follows some practices that I've found useful:
concurrency
section means that if a push to an existing PR or tomaster
happens while the workflow is running, the run is canceled and new one is kicked offon: workflow_dispatch
means that you can kick off a test run manually via Github's web UIon: push
section will run the workflow on any push tomaster
on: pull_request
section will run the workflow just once for any change to a PR ("open" or "synchronize") -- by default GA will run the workflow twice when commits are pushed onto an existing PRAnd the final
jobs
section is just a placeholder job that can be removed after this is merged.