You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by zr...@apache.org on 2021/10/07 09:02:33 UTC

[camel] branch main updated (d38bd85 -> c8529e3)

This is an automated email from the ASF dual-hosted git repository.

zregvart pushed a change to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git.


    from d38bd85  Sync deps
     new 03e1e3b  remove unused attribute from component descriptor
     new c8529e3  website release guide draft

The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 docs/user-manual/antora.yml                        |  4 --
 .../modules/ROOT/pages/release-guide-website.adoc  | 70 ++++++++++++++++++++++
 2 files changed, 70 insertions(+), 4 deletions(-)
 create mode 100644 docs/user-manual/modules/ROOT/pages/release-guide-website.adoc

[camel] 01/02: remove unused attribute from component descriptor

Posted by zr...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

zregvart pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git

commit 03e1e3bcf845480eb5d84fc37cd7dbeddf5f2cbb
Author: David Jencks <dj...@apache.org>
AuthorDate: Tue Oct 5 21:14:03 2021 -0700

    remove unused attribute from component descriptor
---
 docs/user-manual/antora.yml | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/docs/user-manual/antora.yml b/docs/user-manual/antora.yml
index c93e006..2b9bbb6 100644
--- a/docs/user-manual/antora.yml
+++ b/docs/user-manual/antora.yml
@@ -22,7 +22,3 @@ nav:
 - modules/ROOT/nav.adoc
 - modules/faq/nav.adoc
 - modules/ROOT/references.adoc
-
-asciidoc:
-  attributes:
-    eip-vc: components

[camel] 02/02: website release guide draft

Posted by zr...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

zregvart pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git

commit c8529e3db82c0134fe19cd401e7c711a4846a472
Author: David Jencks <dj...@apache.org>
AuthorDate: Tue Oct 5 21:14:54 2021 -0700

    website release guide draft
---
 .../modules/ROOT/pages/release-guide-website.adoc  | 70 ++++++++++++++++++++++
 1 file changed, 70 insertions(+)

diff --git a/docs/user-manual/modules/ROOT/pages/release-guide-website.adoc b/docs/user-manual/modules/ROOT/pages/release-guide-website.adoc
new file mode 100644
index 0000000..f8127b3
--- /dev/null
+++ b/docs/user-manual/modules/ROOT/pages/release-guide-website.adoc
@@ -0,0 +1,70 @@
+= Updating the website after a release of main camel, camel-spring-boot, and camel-karaf
+
+These steps should be done only after the release is voted on and approved.
+
+I'm going to use the notation `<repo short name>:<path>` to indicate the file to be changed.
+For instance, `camel:docs/components/antora.yml` for the `docs/components/antora.yml` component descriptor in the main camel repository, in whatever branch is under discussion.
+
+== 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 `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'.
+
+== After a new release branch is created
+
+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`)
+
+In `camel:docs/components/antora.yml`::
+In `camel-karaf:docs/antora.yml`::
+In `camel-spring-boot:docs/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";`
++
+to e.g.
++
+[source,java]
+private final static String CAMEL_VERSION = "3.12.x";
+
+At this point, build each project (`mvn clean install -Pfastinstall`) and check for generated changes that should be committed.
+
+NOTE: TODO: Is there a step of setting up CI or the regen bot?
+Should maven snapshots be deployed?
+
+=== 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.
+
+There are two cases to consider in modifying `camel-website:antora-playbook.yml`.
+
+New LTS version::
+Release after a non-LTS release::
+* Change the branch of the last release to that of the new release in the sources sections for camel, camel-karaf, and camel-spring-boot.
+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