QRun-IO/qbit-customizable-table-views
3
0 Fork 0
Code Issues Pull Requests 4 Actions Packages Projects Releases 5 Wiki Activity

chore: fix pom.xml metadata, add release docs #5

Open
KofTwentyTwo wants to merge 4 commits from feature/update-bom-and-release-docs into develop
pull from: feature/update-bom-and-release-docs
merge into: QRun-IO:develop
Conversation 0 Commits 4 Files Changed 5
+144 -19
5 changed files with 144 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

.gitignore
+1
View File
@@ -18,3 +18,4 @@ hs_err_pid*
dependency-reduced-pom.xml
/.env.local
/.cache/
.claude/
CONTRIBUTING.md
+4 -2
View File
@@ -1,4 +1,6 @@
# Contributing to QBit User Role Permissions
# Contributing
* See Project [Contributing](https://github.com/Kingsrook/qqq/blob/develop/CONTRIBUTING.md)
See the QQQ project [Contributing Guide](https://github.com/Kingsrook/qqq/blob/develop/CONTRIBUTING.md) for code standards and PR workflow.
For release procedures, see [RELEASING.md](RELEASING.md).
RELEASING.md
+119
View File
@@ -0,0 +1,119 @@
# Releasing
This QBit uses the [qqq-orb](https://circleci.com/developer/orbs/orb/kingsrook/qqq-orb) CircleCI orb for automated builds, versioning, and publishing to Maven Central. Releases are triggered by branch conventions -- no manual version bumping or publishing is required.
## Prerequisites
- CircleCI project linked to this repository
- `qqq-maven-registry-credentials` context configured in CircleCI with:
- `MAVEN_USERNAME` / `MAVEN_PASSWORD` (Sonatype Central Portal)
- `GPG_PRIVATE_KEY_B64` / `GPG_KEYNAME` / `GPG_PASSPHRASE` (artifact signing)
- `GITHUB_TOKEN` (GitHub Release creation)
## Branch Workflow
```
feature/my-work --> develop --> release/X.Y --> main
\--> hotfix/X.Y.Z
```
### Development (develop branch)
Every commit to `develop` publishes a **SNAPSHOT** to Maven Central.
- Version format: `X.Y.Z-SNAPSHOT`
- Consumers use this for integration testing against the latest build
```bash
# Normal development workflow
git checkout develop
git pull
git checkout -b feature/my-feature
# ... make changes, commit, push ...
# Open PR targeting develop
# Merge PR -> SNAPSHOT auto-publishes
```
### Release Candidate (release/* branches)
When `develop` is ready for release, create a release branch. Every commit to a `release/*` branch publishes a **Release Candidate** to Maven Central.
- Version format: `X.Y.Z-RC.1`, `X.Y.Z-RC.2`, etc. (auto-incremented per commit)
- Use this for final QA and stabilization
```bash
# Create a release branch from develop
git checkout develop
git pull
git checkout -b release/0.4
git push -u origin release/0.4
# RC.1 auto-publishes
# If bug fixes are needed during QA:
git commit -m "fix: resolve edge case in view sharing"
git push
# RC.2 auto-publishes (incremented automatically)
```
### Production Release (main branch)
Merge the release branch into `main` to publish a **stable release**.
- Version format: `X.Y.Z`
- Automatically creates a git tag (`vX.Y.Z`) and a GitHub Release
- Published to Maven Central as a final release artifact
```bash
# Merge release branch to main (via PR recommended)
git checkout main
git merge release/0.4
git push
# CI auto-creates tag v0.4.0, GitHub Release, publishes to Maven Central
# After release, merge main back to develop and bump the revision
git checkout develop
git merge main
# Update <revision> in pom.xml to next development version
git commit -m "chore: bump revision to 0.5.0"
git push
```
### Hotfix (hotfix/* branches)
For critical production fixes that cannot wait for the next release cycle.
- Version format: `X.Y.(Z+1)` (patch bump from current release)
- Automatically creates a git tag and GitHub Release
```bash
# Create hotfix branch from main
git checkout main
git pull
git checkout -b hotfix/0.4.1
# ... apply fix ...
git commit -m "fix: critical null check in view loading"
git push -u origin hotfix/0.4.1
# Patch release auto-publishes
# Merge hotfix back to develop
git checkout develop
git merge hotfix/0.4.1
git push
```
## CI/CD Configuration
The release pipeline is defined in `.circleci/config.yml` and uses the `qqq-orb` to handle build, test, version calculation, and publishing. The workflows are:
| Workflow | Trigger | Branch Type | Publishes |
|----------|---------|-------------|-----------|
| `test_only` | Push to feature/* | -- | Nothing (test only) |
| `publish_snapshot` | Push to develop | snapshot | SNAPSHOT to Maven Central |
| `publish_release_candidate` | Push to release/* | release_candidate | RC to Maven Central |
| `publish_release` | Push to main | release | Stable to Maven Central + GitHub Release |
| `publish_hotfix_release` | Push to hotfix/* | hotfix | Patch to Maven Central + GitHub Release |
## Version Management
The project version is controlled by the `<revision>` property in `pom.xml`. The CI pipeline reads and manipulates this value automatically based on branch type. You should only manually update `<revision>` when bumping the development version on `develop` after a release.
pom.xml
+13 -14
View File
@@ -1,23 +1,22 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ QQQ - Low-code Application Framework for Engineers.
~ Copyright (C) 2021-2022. Kingsrook, LLC
~ Copyright (C) 2021-2025. QRunIO, LLC
~ 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
~ contact@kingsrook.com
~ https://github.com/Kingsrook/
~ https://github.com/QRun-IO/
~
~ This program is free software: you can redistribute it and/or modify
~ it under the terms of the GNU Affero General Public License as
~ published by the Free Software Foundation, either version 3 of the
~ License, or (at your option) any later version.
~ Licensed under the Apache License, Version 2.0 (the "License");
~ you may not use this file except in compliance with the License.
~ You may obtain a copy of the License at
~
~ This program is distributed in the hope that it will be useful,
~ but WITHOUT ANY WARRANTY; without even the implied warranty of
~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
~ GNU Affero General Public License for more details.
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ You should have received a copy of the GNU Affero General Public License
~ along with this program. If not, see <https://www.gnu.org/licenses/>.
~ Unless required by applicable law or agreed to in writing, software
~ distributed under the License is distributed on an "AS IS" BASIS,
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
@@ -41,8 +40,8 @@
<licenses>
<license>
<name>GNU Affero General Public License v3.0</name>
<url>https://www.gnu.org/licenses/agpl-3.0.html</url>
<name>Apache License, Version 2.0</name>
<url>https://www.apache.org/licenses/LICENSE-2.0</url>
<distribution>repo</distribution>
</license>
</licenses>
src/main/java/com/kingsrook/qbits/customizabletableviews/CustomizableTableViewsQBitProducer.java
+7 -3
View File
@@ -41,6 +41,10 @@ import com.kingsrook.qqq.backend.core.model.metadata.qbits.QBitMetaDataProducer;
*******************************************************************************/
public class CustomizableTableViewsQBitProducer implements QBitMetaDataProducer<CustomizableTableViewsQBitConfig>
{
public static final String GROUP_ID = "com.kingsrook.qbits";
public static final String ARTIFACT_ID = "customizable-table-views";
public static final String VERSION = "0.4.0";
private CustomizableTableViewsQBitConfig customizableTableViewsQBitConfig;
@@ -52,9 +56,9 @@ public class CustomizableTableViewsQBitProducer implements QBitMetaDataProducer<
public QBitMetaData getQBitMetaData()
{
QBitMetaData qBitMetaData = new QBitMetaData()
.withGroupId("com.kingsrook.qbits")
.withArtifactId("customizable-table-views")
.withVersion("0.1.0")
.withGroupId(GROUP_ID)
.withArtifactId(ARTIFACT_ID)
.withVersion(VERSION)
.withNamespace(getNamespace())
.withConfig(getQBitConfig());