This is an automated email from the ASF dual-hosted git repository. djencks pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel.git
commit 9c0eaf6167e400001882351806c9105e6fce22cd Author: David Jencks <[email protected]> AuthorDate: Fri Nov 12 20:01:56 2021 -0800 update guide to updating website on releases --- .../modules/ROOT/pages/release-guide-website.adoc | 42 +++++++++++++++------- 1 file changed, 29 insertions(+), 13 deletions(-) diff --git a/docs/user-manual/modules/ROOT/pages/release-guide-website.adoc b/docs/user-manual/modules/ROOT/pages/release-guide-website.adoc index f8127b3..5e2f36b 100644 --- a/docs/user-manual/modules/ROOT/pages/release-guide-website.adoc +++ b/docs/user-manual/modules/ROOT/pages/release-guide-website.adoc @@ -8,11 +8,11 @@ For instance, `camel:docs/components/antora.yml` for the `docs/components/antora == Notes on versions Within an Antora component, xrefs to content in the same component, whether or not they are in the same source tree or repository, should never include the `version` or `component` segment of the page id. -Including the version will make the page non-relocatable to another version: for instance specifying `latest` in the main branch will break the link when main is branched for a release. +Including the version will make the page non-relocatable to another version: for instance specifying `next` in the main branch will break the link when main is branched for a release. Including the `component` segment will redirect to the (Antora) latest version, which will typically be the last released version. Antora calculates the latest version as the last non-prerelease version. -Since we are marking the main branch as prerelease, this will never be the main branch, although the version is currently 'latest'. +Since we are marking the main branch as prerelease, this will never be the main branch. == After a new release branch is created @@ -20,30 +20,30 @@ This will always be a branch from `main`. Changes to both `main` and the new branch, say `camel-3.12.x`, will be needed. The changes are almost the same whether the new branch is LTS or not. -=== Changes to `main` branch - -In `camel:docs/components/antora.yml`:: -In `camel-karaf:docs/antora.yml`:: -In `camel-spring-boot:docs/antora.yml`:: -Increment the display-version, e.g. `3.12.x (Prerelease)` to `3.13.x (Prerelease)` - === Changes to the new branch (`3.12.x`) +For each of the projects, `camel`, `camel-karaf`, `camel-spring-boot`, locate the section for the project in the `camel-website` `antora-playbook.yml` and adjust the version in the component descriptor for each start path. +As of writing this consists of: + In `camel:docs/components/antora.yml`:: +In `camel:core/camel-core-engine/src/main/docs/antora.yml`:: In `camel-karaf:docs/antora.yml`:: -In `camel-spring-boot:docs/antora.yml`:: +In `camel-spring-boot/components-starter/antora.yml`:: +In `camel-spring-boot/core/antora.yml`:: +In `camel-spring-boot/docs/components/antora.yml`:: +In `camel-spring-boot/docs/spring-boot/antora.yml`:: + * Change `version` to the branch name e.g. `3.12.x` * Remove the `prerelease` flag line * If the new branch is LTS, set the display-version to e.g. `3.12.x (LTS)`. * If the new branch is not LTS, remove the `display-version` line. In `camel-karaf:tooling/camel-karaf-docs-maven-plugin/src/main/java/org/apache/camel/karaf/maven/ExtMvelHelper.java`:: -In `camel-spring-boot:tooling/camel-spring-boot-docs-maven-plugin/src/main/java/org/apache/camel/springboot/maven/ExtMvelHelper.java`:: change + [source,java] -private final static String CAMEL_VERSION = "latest";` +private final static String CAMEL_VERSION = "next";` + to e.g. + @@ -55,6 +55,17 @@ At this point, build each project (`mvn clean install -Pfastinstall`) and check NOTE: TODO: Is there a step of setting up CI or the regen bot? Should maven snapshots be deployed? +In the `camel-quarkus` project examine the root `pom.xml` of every version used in the website. +There will be a property entry like: + +[source,xml] + <!-- Primary dependencies - maintained manually --> + <camel.major.minor>3.13</camel.major.minor> <!-- run after each change: cd docs && mvnd validate --> + +If the camel version is removed from documentation by this release, update it to the new version. +If the camel version is LTS consider whether it is appropriate to update it to the new version. +If changed, follow the instructions and run mvn validate in the docs directory. + === Changes to the Antora playbook NOTE: After a release, consider whether any LTS versions are now out of service and should be removed from the documentation. @@ -67,4 +78,9 @@ Release after a non-LTS release:: Branches should be listed in reverse release order, newest first, preceded by the `main` prerelease branch. First release after an LTS release:: -* Add a new branch in the sources sections for camel, camel-karaf, and camel-spring-boot between `main` and the last LTS release branch. \ No newline at end of file +* Add a new branch in the sources sections for camel, camel-karaf, and camel-spring-boot between `main` and the last LTS release branch. + +=== Test your work! + +Create branches for each changed branch, push them, use those branches in your playbook, commit the playbook in a branch and push it, and open a PR for the playbook to find out if you missed anything. +Wait for the PR build and netlify preview and check that the build succeeded and the preview looks good.
