Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .forge/addon-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ pluginTier: forge-addon

compatibility:
brxm:
min: "16.3.0"
min: "16.7.0"

repository:
branch: master
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:
contents: write
checks: write
pull-requests: write
uses: bloomreach-forge/ci-workflows/.github/workflows/brxm-ci.yml@v1.0.1
uses: bloomreach-forge/ci-workflows/.github/workflows/brxm-ci.yml@v1.0.2
secrets:
BR_MAVEN_USERNAME: ${{ secrets.BR_MAVEN_USERNAME }}
BR_MAVEN_PASSWORD: ${{ secrets.BR_MAVEN_PASSWORD }}
20 changes: 11 additions & 9 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
name: Deploy Docs

on:
workflow_run:
workflows: ["Release"]
types: [completed]
release:
types: [published]
workflow_dispatch:
inputs:
ref:
Expand All @@ -12,18 +11,21 @@ on:
default: 'master'

jobs:
deploy-docs:
if: >-
github.event_name == 'workflow_dispatch' ||
github.event.workflow_run.conclusion == 'success'
docs:
permissions:
contents: write
uses: bloomreach-forge/ci-workflows/.github/workflows/build-gh-pages.yml@v1.0.1
uses: bloomreach-forge/ci-workflows/.github/workflows/build-gh-pages.yml@v1.0.2
with:
ref: >-
${{ github.event_name == 'workflow_dispatch'
&& inputs.ref
|| github.event.workflow_run.head_sha }}
|| github.event.release.tag_name }}
secrets:
BR_MAVEN_USERNAME: ${{ secrets.BR_MAVEN_USERNAME }}
BR_MAVEN_PASSWORD: ${{ secrets.BR_MAVEN_PASSWORD }}

configure-pages:
needs: docs
permissions:
pages: write
uses: bloomreach-forge/ci-workflows/.github/workflows/configure-gh-pages.yml@v1.0.2
20 changes: 0 additions & 20 deletions .github/workflows/forge-descriptor.yml

This file was deleted.

20 changes: 13 additions & 7 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
name: Release

on:
push:
tags:
- '[0-9]+.[0-9]+.[0-9]+'
workflow_dispatch:
inputs:
version:
description: "Release version (e.g. 1.2.3)"
required: true
next-development-version:
description: "Next SNAPSHOT (e.g. 1.2.4-SNAPSHOT)"
required: true

jobs:
release:
permissions:
contents: write
uses: bloomreach-forge/ci-workflows/.github/workflows/release.yml@v1.0.1
secrets:
BR_MAVEN_USERNAME: ${{ secrets.BR_MAVEN_USERNAME }}
BR_MAVEN_PASSWORD: ${{ secrets.BR_MAVEN_PASSWORD }}
uses: bloomreach-forge/ci-workflows/.github/workflows/release.yml@v1.0.2
with:
version: ${{ inputs.version }}
next-development-version: ${{ inputs.next-development-version }}
secrets: inherit
43 changes: 15 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,46 +21,33 @@ The output will be in `target/site/` and is ignored by Git.

# Release Process

This project uses [git-flow](https://bloomreach-forge.github.io/using-git-flow.html) for releases with automated deployment.
Releases are fully automated via GitHub Actions. No local version bumping or tagging required.

## Steps

1. **Start release and set version**
```bash
git flow release start x.y.z
mvn versions:set -DgenerateBackupPoms=false -DnewVersion="x.y.z"
mvn -f demo/pom.xml versions:set -DgenerateBackupPoms=false -DnewVersion="x.y.z"
git commit -a -m "<ISSUE_ID> releasing x.y.z: set version"
```
1. Merge `develop` into `master`
2. Go to **Actions → Release → Run workflow** (from `master`)
3. Enter the release version (e.g. `5.2.1`) and the next SNAPSHOT (e.g. `5.2.2-SNAPSHOT`)
4. Click **Run workflow**

2. **Finish release** (creates tag, merges to master/develop)
```bash
git flow release finish x.y.z
```
The [Release](.github/workflows/release.yml) workflow will:

3. **Set next snapshot and push** (you're now on develop)
```bash
mvn versions:set -DgenerateBackupPoms=false -DnewVersion="x.y.z+1-SNAPSHOT"
mvn -f demo/pom.xml versions:set -DgenerateBackupPoms=false -DnewVersion="x.y.z+1-SNAPSHOT"
git commit -a -m "<ISSUE_ID> releasing x.y.z: set next development version"
git push origin develop master --follow-tags
```

> Replace `<ISSUE_ID>` with your JIRA ticket (e.g., `FORGE-123`).

The [Release](.github/workflows/release.yml) workflow triggers automatically on the semver tag and will:

1. Verify the tag matches the version in `pom.xml` and `demo/pom.xml`
1. Set the version in `pom.xml` and `demo/pom.xml` to the release version
2. Build and test the project and demo
3. Deploy the artifact to the Bloomreach Forge Maven repository
4. Create a GitHub Release with auto-generated notes
4. Generate `forge-addon.yaml` from `.forge/addon-config.yaml`
5. Commit the release files (`pom.xml` + `forge-addon.yaml`) to `master` and create the `x.y.z` tag — the tag points to this commit, so `forge-addon.yaml` is readable via the GitHub Contents API at that ref
6. Create a GitHub Release with `forge-addon.yaml` also attached as a downloadable asset
7. Bump `pom.xml` and `demo/pom.xml` to the next SNAPSHOT and commit

Once the GitHub Release is published, the [Deploy Docs](.github/workflows/deploy-docs.yml) workflow runs automatically and publishes the updated site to `gh-pages`.

Once the release workflow completes successfully, the [Deploy Docs](.github/workflows/deploy-docs.yml) workflow runs automatically and publishes the updated site to `gh-pages`.
After the release, merge `master` back into `develop` to pick up the SNAPSHOT bump commit.

### Branch model

| Branch | Purpose |
|---|---|
| `develop` | Active development |
| `master` | Prerelease staging — release tags are cut from here |
| `master` | Release branchthe release workflow runs here |
| `gh-pages` | Published documentation (managed by CI, do not edit manually) |
2 changes: 1 addition & 1 deletion demo/cms-dependencies/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>com.bloomreach.forge.camel-hippoevt</groupId>
<artifactId>camel-hippoevt-demo</artifactId>
<version>5.2.0</version>
<version>5.3.0-SNAPSHOT</version>
</parent>
<artifactId>camel-hippoevt-demo-cms-dependencies</artifactId>
<packaging>pom</packaging>
Expand Down
2 changes: 1 addition & 1 deletion demo/cms/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>com.bloomreach.forge.camel-hippoevt</groupId>
<artifactId>camel-hippoevt-demo</artifactId>
<version>5.2.0</version>
<version>5.3.0-SNAPSHOT</version>
</parent>
<artifactId>camel-hippoevt-demo-cms</artifactId>
<packaging>war</packaging>
Expand Down
2 changes: 1 addition & 1 deletion demo/essentials/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>com.bloomreach.forge.camel-hippoevt</groupId>
<artifactId>camel-hippoevt-demo</artifactId>
<version>5.2.0</version>
<version>5.3.0-SNAPSHOT</version>
</parent>
<artifactId>camel-hippoevt-demo-essentials</artifactId>
<packaging>war</packaging>
Expand Down
6 changes: 3 additions & 3 deletions demo/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
<parent>
<groupId>org.onehippo.cms7</groupId>
<artifactId>hippo-cms7-release</artifactId>
<version>16.3.0</version>
<version>16.7.0</version>
</parent>

<name>Bloomreach Camel Event Bus Demo</name>
<description>Bloomreach Camel Event Bus Demo</description>
<groupId>com.bloomreach.forge.camel-hippoevt</groupId>
<artifactId>camel-hippoevt-demo</artifactId>
<version>5.2.0</version>
<version>5.3.0-SNAPSHOT</version>
<packaging>pom</packaging>

<!--
Expand Down Expand Up @@ -72,7 +72,7 @@

<jcip-annotations.version>1.0</jcip-annotations.version>

<essentials.version>16.0.0</essentials.version>
<essentials.version>16.7.0</essentials.version>

<development-module-deploy-dir>shared/lib</development-module-deploy-dir>

Expand Down
2 changes: 1 addition & 1 deletion demo/repository-data/application/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>com.bloomreach.forge.camel-hippoevt</groupId>
<artifactId>camel-hippoevt-demo-repository-data</artifactId>
<version>5.2.0</version>
<version>5.3.0-SNAPSHOT</version>
</parent>

<name>Bloomreach Camel Event Bus Demo Repository Data For Application</name>
Expand Down
2 changes: 1 addition & 1 deletion demo/repository-data/development/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>com.bloomreach.forge.camel-hippoevt</groupId>
<artifactId>camel-hippoevt-demo-repository-data</artifactId>
<version>5.2.0</version>
<version>5.3.0-SNAPSHOT</version>
</parent>

<name>Bloomreach Camel Event Bus Demo Repository Data For Development</name>
Expand Down
2 changes: 1 addition & 1 deletion demo/repository-data/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>com.bloomreach.forge.camel-hippoevt</groupId>
<artifactId>camel-hippoevt-demo</artifactId>
<version>5.2.0</version>
<version>5.3.0-SNAPSHOT</version>
</parent>

<name>Bloomreach Camel Event Bus Demo Repository Data</name>
Expand Down
2 changes: 1 addition & 1 deletion demo/repository-data/site-development/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>com.bloomreach.forge.camel-hippoevt</groupId>
<artifactId>camel-hippoevt-demo-repository-data</artifactId>
<version>5.2.0</version>
<version>5.3.0-SNAPSHOT</version>
</parent>

<name>Bloomreach Camel Event Bus Demo Repository Data For Site Development</name>
Expand Down
2 changes: 1 addition & 1 deletion demo/repository-data/site/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>com.bloomreach.forge.camel-hippoevt</groupId>
<artifactId>camel-hippoevt-demo-repository-data</artifactId>
<version>5.2.0</version>
<version>5.3.0-SNAPSHOT</version>
</parent>

<name>Bloomreach Camel Event Bus Demo Repository Data For Site</name>
Expand Down
2 changes: 1 addition & 1 deletion demo/repository-data/webfiles/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>com.bloomreach.forge.camel-hippoevt</groupId>
<artifactId>camel-hippoevt-demo-repository-data</artifactId>
<version>5.2.0</version>
<version>5.3.0-SNAPSHOT</version>
</parent>

<name>Bloomreach Camel Event Bus Demo Repository Data Web Files</name>
Expand Down
2 changes: 1 addition & 1 deletion demo/site/components/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>com.bloomreach.forge.camel-hippoevt</groupId>
<artifactId>camel-hippoevt-demo-site</artifactId>
<version>5.2.0</version>
<version>5.3.0-SNAPSHOT</version>
</parent>
<artifactId>camel-hippoevt-demo-components</artifactId>
<packaging>jar</packaging>
Expand Down
2 changes: 1 addition & 1 deletion demo/site/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>com.bloomreach.forge.camel-hippoevt</groupId>
<artifactId>camel-hippoevt-demo</artifactId>
<version>5.2.0</version>
<version>5.3.0-SNAPSHOT</version>
</parent>
<artifactId>camel-hippoevt-demo-site</artifactId>
<packaging>pom</packaging>
Expand Down
2 changes: 1 addition & 1 deletion demo/site/webapp/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>com.bloomreach.forge.camel-hippoevt</groupId>
<artifactId>camel-hippoevt-demo-site</artifactId>
<version>5.2.0</version>
<version>5.3.0-SNAPSHOT</version>
</parent>
<artifactId>camel-hippoevt-demo-webapp</artifactId>
<packaging>war</packaging>
Expand Down
10 changes: 5 additions & 5 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@
<parent>
<groupId>org.onehippo.cms7</groupId>
<artifactId>hippo-cms7-project</artifactId>
<version>16.3.0</version>
<version>16.7.0</version>
</parent>

<name>Bloomreach Camel Event Bus Support</name>
<description>Bloomreach Camel Event Bus Support</description>
<groupId>com.bloomreach.forge.camel-hippoevt</groupId>
<artifactId>camel-hippoevt</artifactId>
<version>5.2.0</version>
<version>5.3.0-SNAPSHOT</version>
<url>https://github.com/bloomreach-forge/camel-events-support/</url>

<properties>
Expand Down Expand Up @@ -156,7 +156,7 @@
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
<version>${slf4j2.version}</version>
<scope>provided</scope>
</dependency>

Expand All @@ -172,14 +172,14 @@
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>${slf4j.version}</version>
<version>${slf4j2.version}</version>
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.slf4j</groupId>
<artifactId>jcl-over-slf4j</artifactId>
<version>${slf4j.version}</version>
<version>${slf4j2.version}</version>
<scope>test</scope>
</dependency>

Expand Down
8 changes: 8 additions & 0 deletions src/site/xdoc/release-notes.xml
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,14 @@
</table>
</section>
<section name="Release Notes (5.x)">
<subsection name="5.3.0">
<p class="smallinfo">Release Date: February 24, 2026</p>
<ul>
<li><a href='https://bloomreach.atlassian.net/browse/FORGE-579'>FORGE-579</a><br/>
Upgrade Bloomreach Experience Manager dependency to 16.7.0 and update logging libraries
</li>
</ul>
</subsection>
<subsection name="5.2.0">
<p class="smallinfo">Release Date: February 24, 2026</p>
<ul>
Expand Down