Skip to content

Automatically create release tags via GitHub actions #5649

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.

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

Closed
wants to merge 2 commits into from

Conversation

tautschnig
Copy link
Collaborator

@tautschnig tautschnig commented Dec 10, 2020

The action is currently marked as DRY_RUN: true to perform testing, and
will be enabled in a subsequent PR.
Edit: I have performed testing in my fork (see https://github.com/tautschnig/cbmc/runs/1533820084), and am thus inclined to immediately enable this over here.

  • Each commit message has a non-empty body, explaining why the change was made.
  • Methods or procedures I have added are documented, following the guidelines provided in CODING_STANDARD.md.
  • n/a The feature or user visible behaviour I have added or modified has been documented in the User Guide in doc/cprover-manual/
  • Regression or unit tests are included, or existing tests cover the modified code (in this case I have detailed which ones those are in the commit message).
  • n/a My commit message includes data points confirming performance improvements (if claimed).
  • My PR is restricted to a single feature or bugfix.
  • n/a White-space or formatting changes outside the feature-related changed lines are in commits of their own.

@codecov
Copy link

codecov bot commented Dec 10, 2020

Codecov Report

Merging #5649 (5ad6803) into develop (fd8af8a) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #5649   +/-   ##
========================================
  Coverage    69.44%   69.44%           
========================================
  Files         1243     1243           
  Lines       100612   100612           
========================================
  Hits         69875    69875           
  Misses       30737    30737           
Flag Coverage Δ
cproversmt2 43.14% <ø> (ø)
regression 66.34% <ø> (ø)
unit 32.28% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fd8af8a...5ad6803. Read the comment docs.

- name: Bump version and push tag
uses: anothrNick/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you checked if the default GITHUB_TOKEN has the rights to create a tag? It not being allowed to do some things is something that has bitten me in the past, that's why I’m asking.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call out. I don't know whether this works, but also I'm not sure how to figure it out other than trying it out? (It seems safe to do so: in the worst case, it does not create a tag, and we'd have to go back to the previous, manual approach.)

GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DEFAULT_BUMP: none
RELEASE_BRANCHES: develop
VERBOSE: false
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this read the latest version from the existing tags?
If not we may need INITIAL_VERSION too:

INITIAL_VERSION (optional) - Set initial version before bump. Default 0.0.0.

Probably something like: INITIAL_VERSION: 5.20.1?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Supposedly the bash script behind this GitHub action does check for existing tags. But it may be worth flipping DRY_RUN back on to make sure this does actually work as expected.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have now added a commit to keep in in DRY_RUN mode.

@tautschnig
Copy link
Collaborator Author

A further comment: we should likely wait for anothrNick/github-tag-action#95 to be merged to maintain the cbmc- prefix.

@tautschnig tautschnig self-assigned this Dec 15, 2020
Release tags are now created automatically when including an indicator
(see updated documentation) in the commit message.
We should first make sure this actually works on this repository before
enabling it in production.
@tautschnig tautschnig removed their assignment Dec 16, 2020
@tautschnig tautschnig self-assigned this May 7, 2021
@NlightNFotis
Copy link
Contributor

Hi Michael, I'd love to get this in and experiment with this a bit - it would save us quite a bit of time!

Are you happy to take this forward (rebase on develop) or if you don't have the bandwidth for this, are you happy with me taking this over?*

*: (I'll close this PR and make a new one, but cherry-pick your commits on top of the new branch, and any changes by me will go in another commit, so your authorship is going to be preserved)

@tautschnig tautschnig added the CI label Nov 8, 2022
@tautschnig
Copy link
Collaborator Author

Closing: automatic tagging won't save much time as the tag can be produced at the same time as publishing the changelog.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants