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.

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

Add a GitHub workflow to prepare a release pull request #6972

Merged
merged 1 commit into from
Oct 11, 2023

Conversation

SpecLad
Copy link
Contributor

@SpecLad SpecLad commented Oct 10, 2023

Motivation and context

This automates the first half of the current release process. The second half will be implemented by another workflow.

The reason why it can't all be done in a single workflow is that it's useful to let developers inspect what'll go into the release before actually publishing it, and to apply any last-minute fixes, if necessary. It also allows CI to complete for the release PR.

To support the new workflow, add a --set option to update_version.py that sets the version to a custom value.

How has this been tested?

Manual testing on my fork of CVAT. See a test run here: https://github.com/SpecLad/cvat/actions/runs/6459901481.

Checklist

  • I submit my changes into the develop branch
  • [ ] I have created a changelog fragment
  • [ ] I have updated the documentation accordingly
  • [ ] I have added tests to cover my changes
  • [ ] I have linked related issues (see GitHub docs)
  • [ ] I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

@SpecLad
Copy link
Contributor Author

SpecLad commented Oct 10, 2023

CC @azhavoro

@codecov
Copy link

codecov bot commented Oct 10, 2023

Codecov Report

Merging #6972 (046aa62) into develop (e699848) will increase coverage by 0.00%.
Report is 10 commits behind head on develop.
The diff coverage is 90.00%.

@@           Coverage Diff            @@
##           develop    #6972   +/-   ##
========================================
  Coverage    82.58%   82.58%           
========================================
  Files          360      360           
  Lines        38914    38924   +10     
  Branches      3570     3570           
========================================
+ Hits         32137    32146    +9     
- Misses        6777     6778    +1     
Components Coverage Δ
cvat-ui 77.61% <90.00%> (+<0.01%) ⬆️
cvat-server 87.14% <ø> (ø)

@sizov-kirill
Copy link
Contributor

I also see that it would be nice to have some validation on the version number that prevents increasing one of X, Y or Z on more than 1. Or was it already implemented and I missed it?

@SpecLad
Copy link
Contributor Author

SpecLad commented Oct 10, 2023

I also see that it would be nice to have some validation on the version number that prevents increasing one of X, Y or Z on more than 1.

IMO, this isn't needed. There's no requirement that versions have to be sequential, and we might end up wanting to skip a version for whatever reason.

Although now that you mention it, maybe I should at least add a check that the release does not already exist...

@SpecLad SpecLad marked this pull request as draft October 10, 2023 12:02
@SpecLad SpecLad force-pushed the release-pr-workflow branch 2 times, most recently from 41b59bd to 50a5949 Compare October 10, 2023 12:26
This automates the first half of the current release process. The second
half will be implemented by another workflow.

The reason why it can't all be done in a single workflow is that it's useful
to let developers inspect what'll go into the release before actually
publishing it, and to apply any last-minute fixes, if necessary. It also
allows CI to complete for the release PR.

To support the new workflow, add a `--set` option to `update_version.py`
that sets the version to a custom value.
@SpecLad SpecLad marked this pull request as ready for review October 10, 2023 12:34
@SpecLad SpecLad merged commit 43181a0 into cvat-ai:develop Oct 11, 2023
42 checks passed
@SpecLad SpecLad deleted the release-pr-workflow branch October 11, 2023 09:27
mikhail-treskin pushed a commit to retailnext/cvat that referenced this pull request Oct 25, 2023
This automates the first half of the current release process. The second
half will be implemented by another workflow.

The reason why it can't all be done in a single workflow is that it's
useful to let developers inspect what'll go into the release before
actually publishing it, and to apply any last-minute fixes, if
necessary. It also allows CI to complete for the release PR.

To support the new workflow, add a `--set` option to `update_version.py`
that sets the version to a custom value.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants