Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add workflow responsible for notifying of new TUF spec release #287

Merged
merged 3 commits into from
Jun 10, 2022
Merged

feat: add workflow responsible for notifying of new TUF spec release #287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bd51799
feat: add workflow responsible for notifying of new TUF spec release
rdimitrov May 5, 2022
522208f
chore: limit the permissions for the job calling the version check wo…
rdimitrov May 10, 2022
b29e500
docs: update the MAINTAINERS docs to address a TUF specification bump
rdimitrov Jun 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .github/workflows/specification-version-check.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
on:
schedule:
- cron: "0 13 * * *"
workflow_dispatch:
name: Specification version check
jobs:
# Get the latest TUF specification release and open an issue (if needed)
specification-bump-check:
permissions:
contents: read
issues: write
uses: theupdateframework/specification/.github/workflows/check-latest-spec-version.yml@master
with:
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
rdimitrov marked this conversation as resolved.
Show resolved Hide resolved
9 changes: 7 additions & 2 deletions docs/MAINTAINERS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ Speedy communication makes contributors happy!
Versioning:

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

Project management:

- Try to keep issues up-to-date with status updates!
- Try to keep issues up-to-date with status updates!
- Feel free to ping open issues to check on them.
- Use the "assignee" field to indicate when you are working on an issue.
- 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).
Expand All @@ -45,4 +45,9 @@ Pre-merge (check everything again before hitting the merge button!):
- This may be waived for PRs which only update docs or comments, or trivial changes to tests.
- Make sure that the PR title, commit message, and description are updated if the PR changes significantly during review.

New version of the TUF specification:

- 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/)
- Closing the issue should happen after completing the following steps:
- Review the changes to the specification and make sure they're addressed (possibly requires breaking out a few relevant issues).
- Bump the `tuf-version` in the `.github/workflows/specification-version-check.yml` workflow.