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 workflow to release a new stable version #87

Merged
merged 1 commit into from
Apr 10, 2024

Conversation

kmaziarz
Copy link
Contributor

This PR adds a new GitHub Action that partially automates the process of releasing a new stable version of syntheseus. It tags the latest commit with an appropriate version tag and builds the docs (using a generalized version of the docs building pipeline).

I could not fully test the new action yet since it does not exist on main, but in case any issues arise when releasing v0.4.0 the action will be updated in a follow-up PR.

@kmaziarz kmaziarz requested review from AustinT and mrwnmsr April 10, 2024 13:43
Copy link

@mrwnmsr mrwnmsr left a comment

Choose a reason for hiding this comment

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

looks good to me

@kmaziarz kmaziarz merged commit 75eb796 into main Apr 10, 2024
5 checks passed
@kmaziarz kmaziarz deleted the kmaziarz/release-pipeline branch April 10, 2024 15:20
kmaziarz added a commit that referenced this pull request Apr 10, 2024
The version release workflow added in #87 had a few issues, which are
all fixed in this PR:
- the step to create the git tag did not check out the repository, nor
did it configure the git credentials properly
- the same version string was used for both tagging and building the
docs, while we currently use the `vX.Y.Z` format for the tag and `X.Y.Z`
for the docs version
- the doc building step did not specify a dependency on the tagging
step, which meant it would run and publish the docs even if tagging was
not successful
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