Skip to content

Rework the release process#2

Merged
ripienaar merged 1 commit intomainfrom
rework-release
Aug 26, 2024
Merged

Rework the release process#2
ripienaar merged 1 commit intomainfrom
rework-release

Conversation

@smortex
Copy link
Copy Markdown
Member

@smortex smortex commented Aug 26, 2024

Now that we use some of the Vox Pupuli tooling, we want to update the way
we prepare a release: the release:prepare rake tasks from Vox Pupuli
is not unsable with our current setup, so update he prep_version rake
tasks to update the version in both the .ddl and the .json files, and
also write some boilerplate in the CHANGELOG.md file. The call
sequence is the same as used before to release a module:

$ bundle exec rake prep_version VERSION=5.5.0

When the changes are ready, a release is done from the main branch of
the repository by tagging the code and pushing the tag to GitHub where a
GitHub action will do the actual release:

$ git tag 5.5.0
$ git push --tags

Now that we use some of the Vox Pupuli tooling, we want to update the way
we prepare a release: the `release:prepare` rake tasks from Vox Pupuli
is not unsable with our current setup, so update he `prep_version` rake
tasks to update the version in both the .ddl and the .json files, and
also write some boilerplate in the `CHANGELOG.md` file.  The call
sequence is the same as used before to release a module:

```sh-session
foo-agent $ bundle exec rake prep_version VERSION=5.5.0
```

When the changes are ready, a release is done from the `main` branch of
the repository by tagging the code and pushing the tag to GitHub where a
GitHub action will do the actual release:

```sh-session
foo-agent $ git tag 5.5.0
foo-agent $ git push --tags
```
@smortex
Copy link
Copy Markdown
Member Author

smortex commented Aug 26, 2024

To test these changes with modulesync:

$ bundle exec msync update --noop

(A diff of each change is shown, the files in modules/... are updated and can be inspected)

These changes can also be reviewed from the PR directly: the Run msync --noop against all modules test has a Run msync --noop tasks that basically run this command direct link.

Without --noop, modulesync will commit the changes in each repo and push the branch to GitHub. Providing a custom commit message can be great:

$ bundle exec msync update --message "Rework the release process"

I like to use the gh command to open Pull-Requests when the changes are ready, I usually go with:

$ bundle exec msync execute -- gh pr create --fill --draft

@ripienaar ripienaar merged commit 870bef7 into main Aug 26, 2024
@ripienaar ripienaar deleted the rework-release branch August 26, 2024 12:26
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