Skip to content

Commit

Permalink
fix(doc): add a last released variable
Browse files Browse the repository at this point in the history
Closes #5951
  • Loading branch information
squakez committed Nov 29, 2024
1 parent 3909efe commit 1123093
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 4 deletions.
1 change: 1 addition & 0 deletions docs/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ asciidoc:
attributes:
requires: "'util=camel-website-util,ck=xref:js/ck.js'"
prerelease: true
last-released-version: 2.5.0
camel-k-runtime-version: 3.15.0
camel-api-versions: camel.apache.org/v1 camel.apache.org/v1alpha1 # from Makefile BUNDLE_CAMEL_APIS
camel-version: 4.8.0
Expand Down
5 changes: 3 additions & 2 deletions docs/modules/ROOT/pages/concepts/dependencies.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ From Camel K version 2 onward you will be able to use any Camel K Runtime. Each

[caption=]
.Camel dependencies matrix
[width="100%",cols="4,2,2,2,2,3",options="header"]
[width="100%",cols="4,2,2,2,2,2,3",options="header"]
|===
|Camel K Version
|Last release
|(Default) Camel K Runtime
|Camel Quarkus
|Camel
Expand All @@ -15,7 +16,7 @@ From Camel K version 2 onward you will be able to use any Camel K Runtime. Each
|===

//cannot use top level index.adoc as the page with the query is always omitted.
indexTable::[version="*",relative="running/running.adoc",cellformats="util.ckRef(pageComponentDisplayVersion, pageComponentVersion)|camelKRuntimeVersion|util.camelQuarkusRef(camelQuarkusVersion, camelQuarkusDocsVersion)|util.camelRef(camelVersion, camelDocsVersion)|util.quarkusRef(quarkusVersion)|ck.branch(pageComponentVersion)", requires={requires},transform=util.sortCompatibilityItems]
indexTable::[version="*",relative="running/running.adoc",cellformats="util.ckRef(pageComponentDisplayVersion, pageComponentVersion)|lastReleasedVersion|camelKRuntimeVersion|util.camelQuarkusRef(camelQuarkusVersion, camelQuarkusDocsVersion)|util.camelRef(camelVersion, camelDocsVersion)|util.quarkusRef(quarkusVersion)|ck.branch(pageComponentVersion)", requires={requires},transform=util.sortCompatibilityItems]
== Other APIs version matrix
Expand Down
4 changes: 2 additions & 2 deletions docs/modules/ROOT/pages/installation/installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ https://kustomize.io[Kustomize] provides a declarative approach to the configura

```
$ kubectl create ns camel-k
$ kubectl apply -k github.com/apache/camel-k/install/overlays/kubernetes/descoped?ref=v2.4.0 --server-side
$ kubectl apply -k github.com/apache/camel-k/install/overlays/kubernetes/descoped?ref=v{last-released-version} --server-side
```

You can specify as `ref` parameter the version you're willing to install (ie, `v2.4.0`). The command above will install a descoped (global) operator in the camel-k namespace. This is the suggested configuration in order to manage Integrations in all namespaces.
You can specify as `ref` parameter the version you're willing to install (ie, `v{last-released-version}`). The command above will install a descoped (global) operator in the camel-k namespace. This is the suggested configuration in order to manage Integrations in all namespaces.

[[helm]]
=== Installation via Helm Hub
Expand Down
3 changes: 3 additions & 0 deletions script/update_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
location=$(dirname $0)

echo "Scraping information from Makefile"
LAST_RELEASED_VERSION=$(grep '^LAST_RELEASED_VERSION ?= ' Makefile | sed 's/^.* \?= //')
RUNTIME_VERSION=$(grep '^DEFAULT_RUNTIME_VERSION := ' Makefile | sed 's/^.* \?= //')

CATALOG="$location/../pkg/resources/resources/camel-catalog-$RUNTIME_VERSION.yaml"
Expand Down Expand Up @@ -52,11 +53,13 @@ fi
CAMEL_QUARKUS_DOCS_VERSION="${BASH_REMATCH[1]}.${BASH_REMATCH[2]}.x"
QUARKUS_VERSION=$(yq '.spec.runtime.metadata."quarkus.version"' $CATALOG)

echo "Camel K latest version: $LAST_RELEASED_VERSION"
echo "Camel K Runtime version: $RUNTIME_VERSION"
echo "Camel version: $CAMEL_VERSION"
echo "Camel Quarkus version: $CAMEL_QUARKUS_VERSION"
echo "Quarkus version: $QUARKUS_VERSION"

yq -i ".asciidoc.attributes.last-released-version = \"$LAST_RELEASED_VERSION\"" $location/../docs/antora.yml
yq -i ".asciidoc.attributes.camel-k-runtime-version = \"$RUNTIME_VERSION\"" $location/../docs/antora.yml
yq -i ".asciidoc.attributes.camel-version = \"$CAMEL_VERSION\"" $location/../docs/antora.yml
yq -i ".asciidoc.attributes.camel-docs-version = \"$CAMEL_DOCS_VERSION\"" $location/../docs/antora.yml
Expand Down

0 comments on commit 1123093

Please sign in to comment.