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
27 changes: 27 additions & 0 deletions .forge/addon-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Bloomreach Camel Event Bus Support
# Config for forge-addon.yaml auto-generation

category: integrations
pluginTier: forge-addon

compatibility:
brxm:
min: "16.3.0"

repository:
branch: master

artifacts:
- artifactId: camel-hippoevt
target: site/components
scope: compile
description: "Apache Camel component and utilities for Hippo Repository event integration"

documentation:
- type: site
url: https://bloomreach-forge.github.io/camel-events-support/

installation:
target:
- site
verification: "Configure a Camel route using the hippoevent: component to consume Hippo Repository events"
40 changes: 40 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: CI

on:
pull_request:
branches: [develop, main, master]
types: [opened, synchronize, reopened]
push:
branches: [develop, main, master]

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
fork-notice:
if: >-
github.event_name == 'pull_request' &&
github.event.pull_request.head.repo.full_name != github.repository
runs-on: ubuntu-latest
steps:
- name: Fork PR — build skipped
run: |
echo "::notice::This PR originates from a fork and cannot access repository secrets."
echo "The build requires credentials for Bloomreach's private Maven repository."
echo ""
echo "A maintainer should pull this branch locally and run:"
echo " mvn -B clean install && mvn -B -f demo/pom.xml clean verify"

build:
if: >-
github.event_name == 'push' ||
github.event.pull_request.head.repo.full_name == github.repository
permissions:
contents: write
checks: write
pull-requests: write
uses: bloomreach-forge/ci-workflows/.github/workflows/brxm-ci.yml@v1.0.1
secrets:
BR_MAVEN_USERNAME: ${{ secrets.BR_MAVEN_USERNAME }}
BR_MAVEN_PASSWORD: ${{ secrets.BR_MAVEN_PASSWORD }}
29 changes: 29 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Deploy Docs

on:
workflow_run:
workflows: ["Release"]
types: [completed]
workflow_dispatch:
inputs:
ref:
description: 'Tag or branch to build docs from'
required: true
default: 'master'

jobs:
deploy-docs:
if: >-
github.event_name == 'workflow_dispatch' ||
github.event.workflow_run.conclusion == 'success'
permissions:
contents: write
uses: bloomreach-forge/ci-workflows/.github/workflows/build-gh-pages.yml@v1.0.1
with:
ref: >-
${{ github.event_name == 'workflow_dispatch'
&& inputs.ref
|| github.event.workflow_run.head_sha }}
secrets:
BR_MAVEN_USERNAME: ${{ secrets.BR_MAVEN_USERNAME }}
BR_MAVEN_PASSWORD: ${{ secrets.BR_MAVEN_PASSWORD }}
20 changes: 20 additions & 0 deletions .github/workflows/forge-descriptor.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Update Forge Descriptor

on:
push:
branches: [master]
paths:
- 'pom.xml'
- '.forge/**'
- 'README.md'
release:
types: [published]
workflow_dispatch:

jobs:
generate:
permissions:
contents: write
uses: bloomreach-forge/ci-workflows/.github/workflows/forge-descriptor.yml@v1.0.1
with:
readme-path: README.md
15 changes: 15 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: Release

on:
push:
tags:
- '[0-9]+.[0-9]+.[0-9]+'

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 }}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
.idea
target
storage
docs
61 changes: 53 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,62 @@ Apache Camel - Hippo Events Support provides:
- A Camel Repository Scheduler Job component which can invoke a Camel Endpoint URI
- Utility classes to help integration between Hippo CMS/Repository and Apache Camel.

# Documentation
# Documentation

Documentation is available at [bloomreach-forge.github.io/camel-events-support](https://bloomreach-forge.github.io/camel-events-support)

The documentation is generated by this command from the master branch:
Docs are built automatically from the release tag and deployed to the `gh-pages` branch by the [Deploy Docs](.github/workflows/deploy-docs.yml) workflow. They can also be triggered manually via `workflow_dispatch`.

> mvn clean site:site -Pgithub.pages

The output is in the ```/docs``` directory; push it and GitHub Pages will serve the site automatically.
To preview docs locally:

For rendering documentation on non-master branches, use the normal site command so the output will be in the ```/target```
and therefore ignored by Git.
```
mvn clean site:site
```

> mvn clean site:site
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.

## 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"
```

2. **Finish release** (creates tag, merges to master/develop)
```bash
git flow release finish x.y.z
```

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`
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

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`.

### Branch model

| Branch | Purpose |
|---|---|
| `develop` | Active development |
| `master` | Prerelease staging — release tags are cut from 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.1.1-SNAPSHOT</version>
<version>5.2.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.1.1-SNAPSHOT</version>
<version>5.2.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.1.1-SNAPSHOT</version>
<version>5.2.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.0.0</version>
<version>16.3.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.1.1-SNAPSHOT</version>
<version>5.2.0-SNAPSHOT</version>
<packaging>pom</packaging>

<!--
Expand Down Expand Up @@ -64,7 +64,7 @@
<!-- ***END temporary override of versions*** -->

<forge.camel-hippoevt.version>${project.version}</forge.camel-hippoevt.version>
<camel.version>4.10.5</camel.version>
<camel.version>4.14.4</camel.version>
<activemq.version>6.1.3</activemq.version>

<httpcore4-version>4.4.14</httpcore4-version>
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.1.1-SNAPSHOT</version>
<version>5.2.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.1.1-SNAPSHOT</version>
<version>5.2.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.1.1-SNAPSHOT</version>
<version>5.2.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.1.1-SNAPSHOT</version>
<version>5.2.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.1.1-SNAPSHOT</version>
<version>5.2.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.1.1-SNAPSHOT</version>
<version>5.2.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.1.1-SNAPSHOT</version>
<version>5.2.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.1.1-SNAPSHOT</version>
<version>5.2.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.1.1-SNAPSHOT</version>
<version>5.2.0-SNAPSHOT</version>
</parent>
<artifactId>camel-hippoevt-demo-webapp</artifactId>
<packaging>war</packaging>
Expand Down
Loading