You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@activemq.apache.org by ro...@apache.org on 2021/08/27 12:49:57 UTC
[activemq-website] branch main updated: update current-releases
config and instructions/scripts such that live editing it during release
additions works as expected
This is an automated email from the ASF dual-hosted git repository.
robbie pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/activemq-website.git
The following commit(s) were added to refs/heads/main by this push:
new 6d37695 update current-releases config and instructions/scripts such that live editing it during release additions works as expected
6d37695 is described below
commit 6d37695e9bd11cdbfbe0123e286ab7063d70d0c2
Author: Robbie Gemmell <ro...@apache.org>
AuthorDate: Fri Aug 27 13:44:00 2021 +0100
update current-releases config and instructions/scripts such that live editing it during release additions works as expected
---
README.md | 4 +---
_config.yml | 9 +++------
serve.sh | 5 ++++-
src/_data/current_releases.yml | 6 ++++++
src/_layouts/5x_release.md | 2 +-
src/components/artemis/documentation/previous_docs.md | 2 +-
src/components/artemis/download/index.md | 2 +-
src/components/artemis/download/past_releases.md | 2 +-
src/components/classic/download/index.md | 2 +-
src/release-guide.md | 2 +-
10 files changed, 20 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index 35dc5f9..c9470d6 100644
--- a/README.md
+++ b/README.md
@@ -31,12 +31,10 @@ You can then use Bundler to install the required dependencies:
You can now build (from the `src` directory, to the `_site` output directory) and serve + reload the site locally using Jekyll to test changes as you make them:
- bundle exec jekyll serve --incremental --livereload
+ bundle exec jekyll serve --livereload
You can view the site by navigating to the printed `Sever Address`, e.g http://127.0.0.1:4000.
-_NOTE_: Changes to the _config.yml file (such as to update the current releases detail) are intentionally not reloaded by _jekyll serve_. You must stop and re-start the process to pick them up.
-
Alternatively, rather than serving the site, to just build the site simply run:
bundle exec jekyll build
diff --git a/_config.yml b/_config.yml
index d13d2af..b9761d5 100644
--- a/_config.yml
+++ b/_config.yml
@@ -18,12 +18,9 @@ collections:
output: true
permalink: /:name
-# Current release streams "x.y.[z]" prefixes
-current_artemis_releases:
- - "2.18."
-current_5x_releases:
- - "5.16."
- - "5.15."
+# The Current Releases config moved to src/_data/current_releases.yml
+# so 'jekyll serve' picks up edits to it and generates the expected
+# updates (whereas changes to _config.yml are deliberately ignored).
defaults:
- scope:
diff --git a/serve.sh b/serve.sh
index e166ea1..5e77744 100755
--- a/serve.sh
+++ b/serve.sh
@@ -1,5 +1,8 @@
set -e
bundle install
-bundle exec jekyll serve --incremental --livereload
+# Not using --incremental as it doesnt interact well with the
+# metadata based generation used in release process updates
+# and isnt dramatically faster regardless.
+bundle exec jekyll serve --livereload
set +e
diff --git a/src/_data/current_releases.yml b/src/_data/current_releases.yml
new file mode 100644
index 0000000..fa4c318
--- /dev/null
+++ b/src/_data/current_releases.yml
@@ -0,0 +1,6 @@
+# Current release streams "x.y.[z]" prefixes
+artemis:
+ - "2.18."
+5x:
+ - "5.16."
+ - "5.15."
diff --git a/src/_layouts/5x_release.md b/src/_layouts/5x_release.md
index 3241bc2..db22a82 100644
--- a/src/_layouts/5x_release.md
+++ b/src/_layouts/5x_release.md
@@ -14,7 +14,7 @@ ActiveMQ {{page.version}} Release
{% assign releases = site["5x_releases"] | reverse %}
{% assign isCurrentRelease = false %}
-{% for current_release in site.current_5x_releases %}
+{% for current_release in site.data.current_releases["5x"] %}
{% for release in releases %}
{% if release.version contains current_release %}
{% if release.version == page.version %}
diff --git a/src/components/artemis/documentation/previous_docs.md b/src/components/artemis/documentation/previous_docs.md
index f77b946..ffaccb5 100644
--- a/src/components/artemis/documentation/previous_docs.md
+++ b/src/components/artemis/documentation/previous_docs.md
@@ -7,7 +7,7 @@ type: artemis
{% assign reversed_releases = site["artemis_releases"] | reverse %}
{% assign current_releases = "" | split: ',' %}
-{% for current_release_prefix in site.current_artemis_releases %}
+{% for current_release_prefix in site.data.current_releases["artemis"] %}
{% for release in reversed_releases %}
{% if release.version contains current_release_prefix %}
{% assign current_releases = current_releases | push: release.version %}
diff --git a/src/components/artemis/download/index.md b/src/components/artemis/download/index.md
index 4ea59d8..44c608e 100644
--- a/src/components/artemis/download/index.md
+++ b/src/components/artemis/download/index.md
@@ -11,7 +11,7 @@ The keys file for verifying these releases can be obtained <a href="https://down
{% assign reversed_releases = site["artemis_releases"] | reverse %}
-{% for current_release_prefix in site.current_artemis_releases %}
+{% for current_release_prefix in site.data.current_releases["artemis"] %}
{% for release in reversed_releases %}
{% if release.version contains current_release_prefix %}
#### ActiveMQ Artemis {{release.version}} ({{release.release_date}})
diff --git a/src/components/artemis/download/past_releases.md b/src/components/artemis/download/past_releases.md
index 21cc06a..bb213d9 100644
--- a/src/components/artemis/download/past_releases.md
+++ b/src/components/artemis/download/past_releases.md
@@ -14,7 +14,7 @@ For any releases not shown here, check the [archive](https://archive.apache.org/
{% assign reversed_releases = site["artemis_releases"] | reverse %}
{% assign current_releases = "" | split: ',' %}
-{% for current_release_prefix in site.current_artemis_releases %}
+{% for current_release_prefix in site.data.current_releases["artemis"] %}
{% for release in reversed_releases %}
{% if release.version contains current_release_prefix %}
{% assign current_releases = current_releases | push: release.version %}
diff --git a/src/components/classic/download/index.md b/src/components/classic/download/index.md
index c063a9d..beb31cc 100644
--- a/src/components/classic/download/index.md
+++ b/src/components/classic/download/index.md
@@ -10,7 +10,7 @@ These are the current releases. For prior releases, please see the [past release
{% assign releases = site["5x_releases"] | reverse %}
-{% for current_release in site.current_5x_releases %}
+{% for current_release in site.data.current_releases["5x"] %}
{% for release in releases %}
{% if release.version contains current_release %}
#### ActiveMQ {{release.version}} ({{release.release_date}})
diff --git a/src/release-guide.md b/src/release-guide.md
index 74f81db..7c5753a 100644
--- a/src/release-guide.md
+++ b/src/release-guide.md
@@ -195,7 +195,7 @@ Announcing the ActiveMQ Release
---
Apache ActiveMQ {{ page.version }} was released on {{ page.release_date }}. It fully supports JDK 9+ at runtime and includes several resolved [issues]({{ page.release_notes }}) and bug fixes.
```
-3. If necessary, update the current versions by updating the `current_5x_releases` list in `_config.yml`. The latest patch release published in `src/_releases/` for the major.minor versions in the list will automatically be included on the [download page](https://activemq.apache.org/components/classic/download/).
+3. If necessary, update the current versions by editing the `5x` list in `src/_data/current_releases.yml`. The latest patch release published in `src/_releases/` for the major.minor versions in the list will automatically be included on the [download page](https://activemq.apache.org/components/classic/download/).
4. Update the [Xml Reference](xml-reference) page with a link to the HTML and XSD
7. Update [QuickLinks](quicklinks) and [JavaDocs](docs) pages
8. Mail the [dev](mailto:dev@activemq.apache.org) & [user](mailto:user@activemq.apache.org) lists