From 65419737704639199f834abd8d9ec4f4a1133fb1 Mon Sep 17 00:00:00 2001 From: Jason Karns Date: Wed, 22 Feb 2023 23:29:24 -0500 Subject: [PATCH] Update README.md --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a46ae92..cae0d52 100644 --- a/README.md +++ b/README.md @@ -1 +1,16 @@ -# .github \ No newline at end of file +# .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).