Update Release Guide

[zbendhiba]

Hello,

I've had done some additional steps, regarding what we have in the release guide here : https://camel.apache.org/camel-quarkus/next/contributor-guide/release-guide.html

And this is how I'd love to update the release guide :

• When we generate the 2.6.x branch. Before pushing the branch, we need to update the antora version, but also scripts (as we push a snapshot version. See this commit as a reference : d4357cf
  I wonder if we could automate this, using maven. Let me know
• When we update the subversion repository, we delete the latest version, before announcing the new one in the camel website : For some time, the download page doesn't work.
  I'd advise we keep the 2 latest versions. It could make the download page happy + Camel K is not updated yet + https://code.quarkus.io/ presents the 2 latest versions.
  Would love to have some feedback on this.
• When we add the release on the website, we must add the new version on the website too. See commit here: apache/camel-website@b458d78
  I'd advise also to just keep 2 latest versions, for same reason as precedent point.
• Review the paragraph of updating camel-quarkus-examples . The PR must have the next version, and not the next version of snapshot. Maybe do as for the release a push of the tag and release branch ? There is a direct push to main that must be reviewed.
  I can propose a PR for this update
• update the quarkus platform : use their maven wrapper, as I had an issue with my new maven version, getting more than 100+ files updated, due to style difference. Using the ./mvnw instead made the PR better.

[djencks]

In general we can’t predict how many older version need to be kept on the website: it depends on what other subprojects are referencing them. I’m going to try to make this really explicit, as I proposed on the mailing list. I’m also going to try to update the user-manual release-guide-website.adoc page to cover the website changes needed for subproject releases since they are basically the same as for camel/camel-karaf/camel-spring-boot. Apache policy says the download page should only show “branches" for which further development is planned, and the download area should only have these releases. Others are permanently available in the “historical” section somewhere. When I looked recently I thought that the download area needed cleanup for most or all camel subprojects. I think this means for camel-quarkus that there should only be one release on the download page and in the download area. Main camel would have one short-term release and all the current LTS releases. There are going to be more doc versions visible than versions shown on the download page. The maven updates of antora.yml are nice but not yet sophisticated enough, they are causing problems after release.

…

On Nov 30, 2021, at 1:53 AM, Zineb BENDHIBA ***@***.***> wrote: Hello, I've had done some additional steps, regarding what we have in the release guide here : https://camel.apache.org/camel-quarkus/next/contributor-guide/release-guide.html <https://camel.apache.org/camel-quarkus/next/contributor-guide/release-guide.html> And this is how I'd love to update the release guide : When we generate the 2.6.x branch. Before pushing the branch, we need to update the antora version, but also scripts (as we push a snapshot version. See this commit as a reference : d4357cf <d4357cf> I wonder if we could automate this, using maven. Let me know When we update the subversion repository <https://camel.apache.org/camel-quarkus/next/contributor-guide/release-guide.html#_update_the_apache_camel_quarkus_distribution_subversion_repository.>, we delete the latest version, before announcing the new one in the camel website : For some time, the download page <https://camel.apache.org/download/#camel-quarkus>doesn't work. I'd advise we keep the 2 latest versions. It could make the download page happy + Camel K is not updated yet + https://code.quarkus.io/ <https://code.quarkus.io/> presents the 2 latest versions. Would love to have some feedback on this. When we add the release on the website, we must add the new version on the website too. See commit here: ***@***.*** <apache/camel-website@b458d78> I'd advise also to just keep 2 latest versions, for same reason as precedent point. Review the paragraph of updating camel-quarkus-examples <https://camel.apache.org/camel-quarkus/next/contributor-guide/release-guide.html#_upgrade_and_tag_examples>. The PR must have the next version, and not the next version of snapshot. Maybe do as for the release a push of the tag and release branch ? There is a direct push to main that must be reviewed. I can propose a PR for this update update the quarkus platform <https://camel.apache.org/camel-quarkus/next/contributor-guide/release-guide.html#_upgrade_camel_quarkus_in_quarkus_platform> : use their maven wrapper, as I had an issue with my new maven version, getting more than 100+ files updated, due to style difference. Using the ./mvnw instead made the PR better. — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#3350>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAELDXX3RIPJYLCYEHPSULTUOSNLLANCNFSM5JBK4XQQ>.

[ppalaga]

• When we generate the 2.6.x branch. Before pushing the branch, we need to update the antora version, but also scripts (as we push a snapshot version. See this commit as a reference : d4357cf

Could you please explain why the replacement from version: 2.5.x to version: latest?

I wonder if we could automate this, using maven. Let me know

There is commit-release-changes profile https://github.com/apache/camel-quarkus/blob/main/pom.xml#L972-L1026 that is active for both the release commit and the commit after: https://github.com/apache/camel-quarkus/blob/main/pom.xml#L331-L332
You may want to make tooling/scripts/update-antora-yaml.groovy behave differently depending on project.version.endsWith('-SNAPSHOT') - if that's true it is the commit after, otherwise it is the release commit. Is that what you look for?

• When we update the subversion repository, we delete the latest version, before announcing the new one in the camel website : For some time, the download page doesn't work.
  I'd advise we keep the 2 latest versions. It could make the download page happy + Camel K is not updated yet + https://code.quarkus.io/ presents the 2 latest versions.
  Would love to have some feedback on this.

Sound good to me.

• When we add the release on the website, we must add the new version on the website too. See commit here: apache/camel-website@b458d78
  I'd advise also to just keep 2 latest versions, for same reason as precedent point.

+1

• Review the paragraph of updating camel-quarkus-examples . The PR must have the next version, and not the next version of snapshot. Maybe do as for the release a push of the tag and release branch ? There is a direct push to main that must be reviewed.

The current text in the guide was meant to first prepare a PR with a SNAPSHOT version, let the CI test it, then merge the PR and only after that update to the release-like version, tag and push directly without running the CI.
Yes, the release-like version can be used already in the PR. It is indeed perhaps a bit simpler. Feel free to update the guide.

Note that the part with the direct push would still be required with some modifications: One would have to fetch&reset from upstream, tag the merged commit and then push the tag. The tag was often asked for @vkasala and his friends :)

• update the quarkus platform : use their maven wrapper, as I had an issue with my new maven version, getting more than 100+ files updated, due to style difference. Using the ./mvnw instead made the PR better.

Ha, you've got me :) I thought those changes were caused by a newer Quarkus BOM generator plugin version. We should propose upgrading their wrapper, FWIW!

[djencks]

I've proposed updating the instructions on updating the website after a release in apache/camel#6497. I think the instructions are now generic and apply to all subprojects: feedback k appreciated.

Apache policy is that the downloads page only show artifacts that are undergoing continued development. For camel subprojects I believe this means any number of LTS releases but only one non-LTS release.

The downloads area is similarly only supposed to have the artifacts listed on the download page.... camel needs to do a lot of cleanup here.

As noted in the proposed doc updates, we can only remove a version from the docs when no other subproject is referencing it. AFAIK the only practical test is to try removing it, build the site, and look for errors.

[zbendhiba]

FYI, I pushed 2 minor changes to the guide : #3413 and #3409