Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonkarns authored Feb 23, 2023
1 parent 284041e commit 6541973
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,16 @@
# .github
# .github

Reusable workflows found in `.github/workflows`.
GitHub does not distinguish workflows that should run in this repository,
from reusable workflows that are expected to be called elsewhere.
The only way to tell is that reusable workflows include `workflow_call` event trigger.

## Releasing

Reusable workflows, like actions, should have a `vMajor` git ref
such that consumers may pin to a fuzzy version and avoid receiving breaking changes.
To that end, the `tag-major` workflow will ensure a `vMajor` ref is kept up to date
in response to pushed tags.

It is recommended in this repository to trigger a release by manually create a GitHub Release,
choosing the next version tag, and publishing (ideally using the generated release notes).

0 comments on commit 6541973

Please sign in to comment.