Rework release preparation tasks #44

smortex · 2022-07-27T23:03:20Z

This is a follow-up to voxpupuli/modulesync_config#788

Voxpupuli contributors used to update a module version and rake changelog before opening a PR for preparing a new release. Some modules now have a REFERENCE.md file that also needs to be updated (by running rake reference), and forgetting to do so will remain unnoticed until rake release complain that the file is not up-to-date (so after the release PR was reviewed and merged).

This PR move the changelog and reference tasks from each module's Rakefile (under modulesync control), to the voxpupuli-release gem, rename them to release:porcelain:changelog and release:porcelain:reference to leave room for new changelog and reference tasks indicating they are new deprecated, and recommand running the new release:prepare task that runs them.

This is indented to help maintainers smoothly update their workflow and provide a framework where additional tasks can be added if need be.

smortex · 2022-07-27T23:12:33Z

Puppet 6 bundle Ruby 2.5, do you think it's time to remove Ruby 2.4 from CI?

lib/voxpupuli/release/rake_tasks.rb

kenyon · 2022-07-27T23:53:44Z

Do we also need to update the readme for these changes?

ekohl · 2022-07-28T08:08:06Z

Puppet 6 bundle Ruby 2.5, do you think it's time to remove Ruby 2.4 from CI?

I think by now that's fine. All our other tooling has dropped 2.4.

bastelfreak · 2022-07-28T08:12:56Z

only our puppet-lint plugins test on 2.4. mostly because I didn't want to do a major release.

ekohl

To share some related work: create_gch_task already exists. It may not be suitable for us now, but it can serve as an inspiration.

lib/voxpupuli/release/rake_tasks.rb

voxpupuli-release.gemspec

lib/voxpupuli/release/rake_tasks.rb

Ruby 2.4 is EoL. We drop it because newer features won't work with Ruby 2.4 anymore: voxpupuli#44

bastelfreak

Looks good to me. Did you test it in any module? I moved the Ruby 2.4 drop to another PR, for a cleaner changelog: #46

ekohl · 2022-08-10T09:02:17Z

lib/voxpupuli/release/rake_tasks.rb

+    options = GitHubChangelogGenerator::Parser.default_options
+    options[:user] = GCGConfig.user
+    options[:project] = GCGConfig.metadata['name']
+    options[:future_release] = "v#{GCGConfig.metadata['version']}" if GCGConfig.metadata['version'] =~ /^\d+\.\d+.\d+$/


Pretty sure not all modules use a v prefix. Ideally it's configurable in GCGConfig.

Also, if you don't use the match object then in modern Ruby it's preferred to use .match?.

Suggested change

options[:future_release] = "v#{GCGConfig.metadata['version']}" if GCGConfig.metadata['version'] =~ /^\d+\.\d+.\d+$/

options[:future_release] = "v#{GCGConfig.metadata['version']}" if GCGConfig.metadata['version'].match?(/^\d+\.\d+.\d+$/)

Pretty sure not all modules use a v prefix. Ideally it's configurable in GCGConfig.

I used to exclude the v because I like tag to be the semver version, but this is unfortunately somewhat broken with GCG and I gave up. As far as I can see, we use a v in the modules tags, and the issues is only when GCG create the links to pages references containing tag that do not exist: if you mix v1.2.3 and 1.2.3 in your existing tags, GCG generates the good url. So not sure it's worth it to have a way to tune something that does not seem broken.

out of 170 modules managed by modulesync on my machine at $WORK, only these do not have a 'v' at the beginning of their last tag:

puppet-augeasproviders_mounttab

puppet-augeasproviders_nagios

puppet-augeasproviders_puppet

puppet-augeasproviders_sysctl

puppet-module

puppet-puppet_summary

These module have not seen a new version recently, maybe we can "standardize" on version numbers with a leading 'v'?

In Foreman we don't have it, and I'd love to standardize the ecosystem in some way, so I'd prefer to the conditional part.

Thinking more about it: tools often have a "tag pattern". That could default to v%s and some modules could override it.

That makes sense 👍

Did this in a new commit (with the other part in voxpupuli/modulesync_config#789). While doing this I realized that the pattern did not match the version we produce after creating a release ("<released-version.minor+1>-rc0", so I though we could remove it.

The idea behind NOT matching rc0 is that we end up generating no future version. That means it ends up being "Unreleased" in the generated changelog. Though I'm not sure if this actually matches the real world.

Got it! 👍 I amended my last commit accordingly

lib/voxpupuli/release/rake_tasks.rb

smortex · 2022-09-01T21:31:58Z

Did you test it in any module?

I run the release:prepare task against the bacula module which is almost ready for a new release. No PR for now, just ensured the expected things happen.

bastelfreak · 2022-11-02T10:38:44Z

@ekohl I know you're quite busy at the moment. Could you please take a look in the next few weeks when you've some spare time? If you like we could also go on with it and implement possible enhancements in the future.

alexjfisher · 2022-11-21T18:48:27Z

README.md

+bundle exec rake release:prepare
+```
+
+Commit these changes (likely in a new branch, open a Pull-Request and wait for it to be reviewed and merged).  When ready to ship the new release, ensure you are on the main branch, it is up-to-date, and run:


Is it possible for the task to create a new branch and create the commit with a standardised commit message? I'd like to see Release x.x.x used consistently.

/me feels like it is too much 😄

Would we can just adjust the message and suggest things:

Please review these changes and commit them to a new branch: git checkout -b release-x.x.x git commit -m "Release x.x.x" Then open a Pull-Request and wait for it to be reviewed and merged).

I had this as local changes in my working directory, so I added a commit with it while rebasing.

This is a follow-up to voxpupuli/modulesync_config#788 Voxpupuli contributors used to update a module version and `rake changelog` before opening a PR for preparing a new release. Some modules now have a REFERENCE.md file that also needs to be updated (by running `rake reference`), and forgetting to do so will remain unnoticed until `rake release` complain that the file is not up-to-date (so after the release PR was reviewed and merged). This PR move the `changelog` and `reference` tasks from each module's Rakefile (under modulesync control), to the voxpupuli-release gem, rename them to `release:porcelain:changelog` and `release:porcelain:reference` to leave room for new `changelog` and `reference` tasks indicating they are new deprecated, and recommand running the new `release:prepare` task that runs them. This is indented to help maintainers smoothly update their workflow and provide a framework where additional tasks can be added if need be.

Include information about the release:prepare task and detail what happen at each stage of the release process.

Co-authored-by: Ewoud Kohl van Wijngaarden <[email protected]>

Tell users to run `strings:generate:reference` directly if needed.

Make this dependency optional. If absent, add a dummy task that describes how to make it functional.

Stop using the GitHubChangelogGenerator rake task generator in order to lazy-evaluate our new GCGConfig.user which defaults to whatever is declared in the module metadata but can be overriden in the module Rakefile.

smortex · 2023-02-14T21:05:42Z

@alexjfisher, @ekohl I think this is ready for merging, but I would love some feedback on the open discussions if you have some time. Thanks!

ekohl

Sorry for the string of reviews. I tend to find more things as time passes. I think this is now pretty close to being merged and we can solve these later if you want.

lib/voxpupuli/release/rake_tasks.rb

ekohl · 2023-02-17T17:14:55Z

lib/voxpupuli/release/rake_tasks.rb

+
+desc "Prepare a release"
+task "release:prepare" do
+  v = Blacksmith::Modulefile.new.version


This now looks unused

It is only used for end-user convenience to output the CLI commands to create the release branch:

git checkout -b release-#{v} git commit -m "Release #{v}"

lib/voxpupuli/release/rake_tasks.rb

ekohl · 2023-02-17T17:17:53Z

lib/voxpupuli/release/rake_tasks.rb

+rescue LoadError
+  desc "Dummy"
+  task "release:porcelain:changelog" do
+    puts "Skipping CHANGELOG.md generation.  Ensure github_changelog_generator is present if you expected it to be generated."


Shouldn't this hard fail instead?

I think we wanted to avoid a hard-failure for projects using our tooling but not hosted on GitHub and where GCG is not usable. I have never tested this however and maybe it is not functional at all… For now I would prefer to keep that this way if you don't mind.

The same way we can customize the user, allow customization of the project name.

Code was moved around and is more complex that necessary. Make it more simple.

Follow rake best-practices.

smortex · 2023-02-17T17:57:49Z

Sorry for the string of reviews. I tend to find more things as time passes. I think this is now pretty close to being merged and we can solve these later if you want.

Yeah, lots of moving parts! I addressed the last issues you raised and marked them as resolved, for the 2 last one I think we can left the code as it is for now.

Thank you for your reviews!

ekohl

The GCGConfig part is blocking, but otherwise 👍

This is starting to really shape up to be a big improvement over our current implementation. I think it's pretty much the last bit that I want to kill in what we modulesync, so thanks for the efforts!

lib/voxpupuli/release/rake_tasks.rb

ekohl

Thanks!

In this branch we include what is required to validate this two PRs: * voxpupuli/modulesync_config#789 (Synced from this branch) * voxpupuli/voxpupuli-release#44 (Fetch the gem form the WIP branch in git rather than Rubygems)

smortex force-pushed the prepare-release-tasks branch from 87facb4 to 9ae63d1 Compare July 27, 2022 23:10

smortex mentioned this pull request Jul 27, 2022

Update REFERENCE.md during CHANGELOG.md creation voxpupuli/modulesync_config#788

Closed

smortex force-pushed the prepare-release-tasks branch from 9ae63d1 to 2ab5672 Compare July 27, 2022 23:15

smortex commented Jul 27, 2022

View reviewed changes

lib/voxpupuli/release/rake_tasks.rb Outdated Show resolved Hide resolved

ekohl reviewed Jul 28, 2022

View reviewed changes

bastelfreak added a commit to bastelfreak/voxpupuli-release that referenced this pull request Aug 10, 2022

Drop Ruby 2.4 support

aa92615

Ruby 2.4 is EoL. We drop it because newer features won't work with Ruby 2.4 anymore: voxpupuli#44

bastelfreak mentioned this pull request Aug 10, 2022

Drop Ruby 2.4 support #46

Merged

bastelfreak reviewed Aug 10, 2022

View reviewed changes

ekohl reviewed Aug 10, 2022

View reviewed changes

smortex force-pushed the prepare-release-tasks branch from 8b8d658 to ce5bc70 Compare September 1, 2022 21:30

bastelfreak approved these changes Sep 1, 2022

View reviewed changes

smortex requested a review from ekohl September 1, 2022 21:32

alexjfisher reviewed Nov 21, 2022

View reviewed changes

smortex and others added 9 commits February 14, 2023 10:52

Improve operation description in the README

2c00fc7

Include information about the release:prepare task and detail what happen at each stage of the release process.

Simplify writting updated CHANGELOG.md

c25dc2a

Co-authored-by: Ewoud Kohl van Wijngaarden <[email protected]>

Remove release:porcelain:reference wrapper

4360026

Tell users to run `strings:generate:reference` directly if needed.

Do not depend on github_changelog_generator

402c53c

Make this dependency optional. If absent, add a dummy task that describes how to make it functional.

Allow customization of the module organization

4c5e959

Stop using the GitHubChangelogGenerator rake task generator in order to lazy-evaluate our new GCGConfig.user which defaults to whatever is declared in the module metadata but can be overriden in the module Rakefile.

Prefer String#match? over the =~ operator

65050cc

Minimize location where we catch exceptions

418dc92

Inline the whore CHANGELOG generation code

d8b6ecf

smortex force-pushed the prepare-release-tasks branch from ce5bc70 to 7f88849 Compare February 14, 2023 20:57

bastelfreak approved these changes Feb 14, 2023

View reviewed changes

smortex force-pushed the prepare-release-tasks branch from 7f88849 to 4d5ee4f Compare February 15, 2023 20:53

Add hints for creating a release branch

02304b0

smortex force-pushed the prepare-release-tasks branch from 4d5ee4f to 763950d Compare February 15, 2023 20:59

ekohl reviewed Feb 17, 2023

View reviewed changes

smortex added 2 commits February 17, 2023 07:26

Allow to customize GCG future_release tag label

a7dcdac

Allow customization of the project name

9bdfcb7

The same way we can customize the user, allow customization of the project name.

smortex force-pushed the prepare-release-tasks branch from ccc4d79 to 9bdfcb7 Compare February 17, 2023 17:26

smortex added 2 commits February 17, 2023 07:36

Symplify the task that generate the changelog

8bf1050

Code was moved around and is more complex that necessary. Make it more simple.

Various Rakefile improvements

42d1db7

Follow rake best-practices.

smortex requested a review from ekohl February 17, 2023 17:57

ekohl reviewed Feb 17, 2023

View reviewed changes

lib/voxpupuli/release/rake_tasks.rb Outdated Show resolved Hide resolved

lib/voxpupuli/release/rake_tasks.rb Outdated Show resolved Hide resolved

lib/voxpupuli/release/rake_tasks.rb Outdated Show resolved Hide resolved

smortex added 3 commits February 17, 2023 08:27

Move the GCGConfig class to the top level

5f3864d

Factorize namespaces nesting

b432f7c

Lazy load puppet_blacksmith

56ea109

smortex requested a review from ekohl February 17, 2023 18:34

ekohl approved these changes Feb 17, 2023

View reviewed changes

smortex mentioned this pull request Feb 17, 2023

Sync with Vox Pupuli opus-codium/modulesync_config#65

Merged

bastelfreak added the enhancement label Feb 18, 2023

bastelfreak approved these changes Feb 18, 2023

View reviewed changes

bastelfreak merged commit df0b32e into master Feb 18, 2023

bastelfreak deleted the prepare-release-tasks branch February 18, 2023 23:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rework release preparation tasks #44

Rework release preparation tasks #44

smortex commented Jul 27, 2022 •

edited

Loading

smortex commented Jul 27, 2022

kenyon commented Jul 27, 2022

ekohl commented Jul 28, 2022

bastelfreak commented Jul 28, 2022

ekohl left a comment

bastelfreak left a comment

ekohl Aug 10, 2022

smortex Sep 1, 2022 •

edited

Loading

smortex Feb 14, 2023

ekohl Feb 15, 2023

ekohl Feb 15, 2023

smortex Feb 15, 2023

smortex Feb 15, 2023

ekohl Feb 17, 2023

smortex Feb 17, 2023

smortex commented Sep 1, 2022 •

edited

Loading

bastelfreak commented Nov 2, 2022

alexjfisher Nov 21, 2022

smortex Dec 13, 2022

smortex Feb 14, 2023 •

edited

Loading

smortex commented Feb 14, 2023

ekohl left a comment

ekohl Feb 17, 2023

smortex Feb 17, 2023

ekohl Feb 17, 2023

smortex Feb 17, 2023

smortex commented Feb 17, 2023

ekohl left a comment

ekohl left a comment

	options[:future_release] = "v#{GCGConfig.metadata['version']}" if GCGConfig.metadata['version'] =~ /^\d+\.\d+.\d+$/
	options[:future_release] = "v#{GCGConfig.metadata['version']}" if GCGConfig.metadata['version'].match?(/^\d+\.\d+.\d+$/)

Rework release preparation tasks #44

Rework release preparation tasks #44

Conversation

smortex commented Jul 27, 2022 • edited Loading

smortex commented Jul 27, 2022

kenyon commented Jul 27, 2022

ekohl commented Jul 28, 2022

bastelfreak commented Jul 28, 2022

ekohl left a comment

Choose a reason for hiding this comment

bastelfreak left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

smortex Sep 1, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

smortex commented Sep 1, 2022 • edited Loading

bastelfreak commented Nov 2, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

smortex Feb 14, 2023 • edited Loading

Choose a reason for hiding this comment

smortex commented Feb 14, 2023

ekohl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

smortex commented Feb 17, 2023

ekohl left a comment

Choose a reason for hiding this comment

ekohl left a comment

Choose a reason for hiding this comment

smortex commented Jul 27, 2022 •

edited

Loading

smortex Sep 1, 2022 •

edited

Loading

smortex commented Sep 1, 2022 •

edited

Loading

smortex Feb 14, 2023 •

edited

Loading