Skip to content

Commit 39c23cb

Browse files
authored
feat: add workflow responsible for notifying of new TUF spec release (#287)
* feat: add workflow responsible for notifying of new TUF spec release Signed-off-by: Radoslav Dimitrov <[email protected]> * chore: limit the permissions for the job calling the version check workflow Signed-off-by: Radoslav Dimitrov <[email protected]> * docs: update the MAINTAINERS docs to address a TUF specification bump Signed-off-by: Radoslav Dimitrov <[email protected]>
1 parent 4139c85 commit 39c23cb

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
on:
2+
schedule:
3+
- cron: "0 13 * * *"
4+
workflow_dispatch:
5+
name: Specification version check
6+
jobs:
7+
# Get the latest TUF specification release and open an issue (if needed)
8+
specification-bump-check:
9+
permissions:
10+
contents: read
11+
issues: write
12+
uses: theupdateframework/specification/.github/workflows/check-latest-spec-version.yml@master
13+
with:
14+
tuf-version: "v1.0.29" # Should be updated to the according version either manually or extracted automatically as how it's done in python-tuf

docs/MAINTAINERS.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ Speedy communication makes contributors happy!
1717
Versioning:
1818

1919
- go-tuf releases follow [SemVer](https://semver.org/) with the following modification:
20-
- While go-tuf is pre-1.0, increment the minor version for any breaking changes (in SemVer, there are no guarantees about API stability).
20+
- While go-tuf is pre-1.0, increment the minor version for any breaking changes (in SemVer, there are no guarantees about API stability).
2121
- Releases should be tagged in this repository as usual in Go ([Publishing a module](https://go.dev/doc/modules/publishing)).
2222

2323
Project management:
2424

25-
- Try to keep issues up-to-date with status updates!
25+
- Try to keep issues up-to-date with status updates!
2626
- Feel free to ping open issues to check on them.
2727
- Use the "assignee" field to indicate when you are working on an issue.
2828
- Use GitHub issue labels to describe the issue (exact labels are still changing, so just look through and add those that seem like a good fit).
@@ -45,4 +45,9 @@ Pre-merge (check everything again before hitting the merge button!):
4545
- This may be waived for PRs which only update docs or comments, or trivial changes to tests.
4646
- Make sure that the PR title, commit message, and description are updated if the PR changes significantly during review.
4747

48+
New version of the TUF specification:
4849

50+
- There's an automated workflow which monitors and opens an issue in case there's newer version of the [TUF specification](https://theupdateframework.github.io/specification/latest/)
51+
- Closing the issue should happen after completing the following steps:
52+
- Review the changes to the specification and make sure they're addressed (possibly requires breaking out a few relevant issues).
53+
- Bump the `tuf-version` in the `.github/workflows/specification-version-check.yml` workflow.

0 commit comments

Comments
 (0)