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

Update "Release process" docs #153

Open
tpvasconcelos opened this issue Dec 30, 2023 · 2 comments
Open

Update "Release process" docs #153

tpvasconcelos opened this issue Dec 30, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@tpvasconcelos
Copy link
Owner

tpvasconcelos commented Dec 30, 2023

Update the "Release process" docs to reflect the current status.

Maybe refactor steps 3. and 4. in a separate script in cicd_utils/ and call it from here. The script should ask for user confirmation before proceeding. To avoid accidental releases, maybe require the user to type out the exact version to be released (you can include the version in the script's output so the user can copy-paste it). The script to validate that the user is running the script from the correct cwd, git branch (main), set the SKIP='no-commit-to-branch' environment variable to skip the pre-commit hook that doesn't allow commits to the main branch, and finally, run the bumpversion <major|minor|patch> command. Maybe ask for confirmation to push all changes and new tags to the remote repository or to revert all changes and tags if the user decides to cancel the release?


Potentially relevant references:

@tpvasconcelos tpvasconcelos added the documentation Improvements or additions to documentation label Dec 30, 2023
@tpvasconcelos tpvasconcelos self-assigned this Dec 30, 2023
@fkiraly
Copy link

fkiraly commented Feb 10, 2024

here's sktime's, in case it would be helpful:

https://www.sktime.net/en/stable/developer_guide/release.html

@tpvasconcelos
Copy link
Owner Author

Great reference! Thanks @fkiraly

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

No branches or pull requests

2 participants