Merge for release 0.3.0

.circleci/config.yml

@@ -1,60 +1,57 @@
 version: 2.1
 
-executors:
-  java-executor:
-    docker:
-      - image: cimg/openjdk:17.0
-
-jobs:
-  verify:
-    executor: java-executor
-    steps:
-      - checkout
-      - restore_cache:
-          keys:
-            - v1-maven-cache-{{ checksum "pom.xml" }}
-      - run:
-          name: Verify with Maven
-          command: mvn -s .circleci/mvn-settings.xml verify
-      - store_test_results:
-          path: target/surefire-reports
-      - save_cache:
-          paths:
-            - ~/.m2/repository
-          key: v1-maven-cache-{{ checksum "pom.xml" }}
-
-  deploy:
-    executor: java-executor
-    steps:
-      - checkout
-      - restore_cache:
-          keys:
-            - v1-maven-cache-{{ checksum "pom.xml" }}
-      - run:
-          name: Deploy with Maven
-          command: mvn -s .circleci/mvn-settings.xml deploy
-      - store_test_results:
-          path: target/surefire-reports
-      - save_cache:
-          paths:
-            - ~/.m2/repository
-          key: v1-maven-cache-{{ checksum "pom.xml" }}
+orbs:
+  qqq-orb: kingsrook/qqq-orb@0.3.7
 
 workflows:
-  version: 2
-  build_and_deploy:
+
+  test_only:
     jobs:
-      - verify:
-          context: qqq-maven-registry-credentials
+      - qqq-orb/mvn_test_only:
+          context: [ qqq-maven-registry-credentials ]
           filters:
             branches:
-              ignore:
-                - main
-                - feature/initial-dev
-      - deploy:
-          context: qqq-maven-registry-credentials
+              ignore: /(develop|main|release/.*|hotfix/.*|integration.*)/
+            tags:
+              only: []  
+
+  publish_snapshot:
+    jobs:
+      - qqq-orb/mvn_publish:
+          context: [ qqq-maven-registry-credentials ]
+          branch_type: snapshot
           filters:
             branches:
               only:
-                - main
-                - feature/initial-dev
+                - develop
+
+  publish_release_candidate:
+    jobs:
+      - qqq-orb/mvn_publish:
+          context: [ qqq-maven-registry-credentials ]
+          branch_type: release_candidate
+          filters:
+            branches:
+              only:
+                - /release\/.*/
+
+  publish_release:
+    jobs:
+      - qqq-orb/mvn_publish:
+          context: [ qqq-maven-registry-credentials ]
+          branch_type: release
+          filters:
+            branches:
+              ignore: /.*/            
+            tags:
+              only: [ /v.*/ ]
+
+  publish_hotfix_release:
+    jobs:
+      - qqq-orb/mvn_publish:
+          context: [ qqq-maven-registry-credentials ]
+          branch_type: hotfix
+          filters:
+            branches:
+              only:
+                - /hotfix\/.*/

.circleci/mvn-settings.xml

@@ -1,9 +0,0 @@
-<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
-    <servers>
-        <server>
-            <id>github-qqq-maven-registry</id>
-            <username>${env.QQQ_MAVEN_REGISTRY_USERNAME}</username>
-            <password>${env.QQQ_MAVEN_REGISTRY_PASSWORD}</password>
-        </server>
-    </servers>
-</settings>

CHANGELOG.md

@@ -0,0 +1,58 @@
+# Changelog
+
+All notable changes to QBit User Role Permissions will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Comprehensive README documentation following QQQ sub repo standards
+- Standard GitHub files (LICENSE, CHANGELOG, CONTRIBUTING, SECURITY, CODE_OF_CONDUCT)
+- Proper project structure and documentation
+
+### Changed
+- Updated README to follow QQQ framework standards
+- Improved project documentation and structure
+- Enhanced GitHub repository setup
+
+## [0.30.0-SNAPSHOT] - 2024-01-XX
+
+### Added
+- Initial QBit implementation for user role permissions
+- Database schema for users, roles, and permissions
+- Java classes for User, Role, Permission, UserRole, and RolePermission
+- Integration with QQQ Backend Core framework
+- H2 database support for testing
+- JUnit 5 test framework integration
+- AssertJ assertions for testing
+- Checkstyle configuration for code quality
+
+### Changed
+- Initial public release of QBit User Role Permissions
+- Established QBit development standards
+- Created modular architecture for permission management
+
+---
+
+## 📚 For Detailed Information
+
+**📖 [Complete Documentation Wiki](https://github.com/Kingsrook/qqq/wiki)** - Start here for comprehensive guides
+- **[🏠 Home](https://github.com/Kingsrook/qqq/wiki/Home)** - Project overview and quick start
+- **[🚀 Release Flow](https://github.com/Kingsrook/qqq/wiki/Release-Flow)** - Detailed release process
+- **[🏷️ Changelog & Tagging](https://github.com/Kingsrook/qqq/wiki/Changelog-and-Tagging)** - Commit conventions and release notes
+- **[🔧 Developer Onboarding](https://github.com/Kingsrook/qqq/wiki/Developer-Onboarding)** - Setup and contribution guide
+
+## 🔄 Version Compatibility
+
+QBit User Role Permissions follows semantic versioning:
+- **MAJOR** versions may contain breaking changes
+- **MINOR** versions add new functionality (backward compatible)
+- **PATCH** versions contain bug fixes (backward compatible)
+
+For detailed compatibility information, see [QQQ Compatibility Matrix](https://github.com/Kingsrook/qqq/wiki/Compatibility-Matrix).
+
+---
+
+**Thank you for using QBit User Role Permissions!** 🚀

CODE_OF_CONDUCT.md

@@ -0,0 +1,4 @@
+# Code of Conduct
+ 
+
+See Project level [Code of Conduct](https://github.com/Kingsrook/qqq/blob/develop/CODE_OF_CONDUCT.md)

CODE_STYLE.md

@@ -0,0 +1,3 @@
+# Code Style Guide
+ 
+* See Project [Code Style Guide](https://github.com/Kingsrook/qqq/blob/develop/CODE_STYLE.md)

CONTRIBUTING.md

@@ -0,0 +1,4 @@
+# Contributing to QBit User Role Permissions
+
+* See Project [Contributing](https://github.com/Kingsrook/qqq/blob/develop/CONTRIBUTING.md)
+

README.md

@@ -1,4 +1,8 @@
-## QBit:  workflows
+# QBit: Workflows
+
+[![Version](https://img.shields.io/badge/version-TODO-blue.svg)](https://github.com/Kingsrook/qbit-workflows)
+[![License](https://img.shields.io/badge/license-GNU%20Affero%20GPL%20v3-green.svg)](https://www.gnu.org/licenses/agpl-3.0.en.html)
+[![Java](https://img.shields.io/badge/java-17+-blue.svg)](https://adoptium.net/)
 
 ### Overview
 *Note:  This is one of the original QBit implementations - so, some of the mechanics of how
@@ -7,6 +11,28 @@ creation... Please excuse any dust or not-quite-round wheels you find here!*
 
 This QBit provides TODO
 
+## 🏗️ Architecture
+
+### Technology Stack
+
+- **Java**: Java 17+ with UTF-8 encoding
+- **Maven**: Build system with plugin management
+- **QQQ Framework**: Built on the QQQ low-code platform
+- **QBit Pattern**: Follows QBit component architecture
+
+### Core Capabilities
+
+- **Workflow Management**: TODO - Define workflow capabilities
+- **Process Automation**: TODO - Define automation features
+- **Integration**: TODO - Define integration capabilities
+
+## 🚀 Quick Start
+
+### Prerequisites
+
+- **Java 17+** (required for QQQ features)
+- **Maven 3.8+** (for build system)
+
 ### Usage
 
 #### Pom dependency
@@ -31,3 +57,53 @@ TODO
 ### Dependencies
 TODO
 
+## 📚 Documentation
+
+**📖 [Complete Documentation Wiki](https://github.com/Kingsrook/qqq/wiki)** - Start here for comprehensive guides
+
+- **[🏠 Home](https://github.com/Kingsrook/qqq/wiki/Home)** - Project overview and quick start
+- **[🏗️ Architecture](https://github.com/Kingsrook/qqq/wiki/High-Level-Architecture)** - System design and principles
+- **[🔧 Development](https://github.com/Kingsrook/qqq/wiki/Developer-Onboarding)** - Setup and contribution guide
+- **[📦 Modules](https://github.com/Kingsrook/qqq/wiki/Core-Modules)** - Available components and usage
+- **[🚀 Building](https://github.com/Kingsrook/qqq/wiki/Building-Locally)** - Local development workflow
+- **[🔧 QBit Development](https://github.com/Kingsrook/qqq/wiki/QBit-Development)** - QBit development guide
+
+## 🤝 Contributing
+
+**Important**: This repository is a component of the QQQ framework. All contributions, issues, and discussions should go through the main QQQ repository.
+
+### Development Workflow
+
+1. **Fork the main QQQ repository**: https://github.com/Kingsrook/qqq
+2. **Create a feature branch**: `git checkout -b feature/amazing-feature`
+3. **Make your changes** (including QBit changes if applicable)
+4. **Run tests**: `mvn test`
+5. **Commit your changes**: `git commit -m 'Add amazing feature'`
+6. **Push to the branch**: `git push origin feature/amazing-feature`
+7. **Open a Pull Request** to the main QQQ repository
+
+### Code Standards
+
+- **Maven**: Follow Maven best practices
+- **Documentation**: Update relevant documentation
+- **Versioning**: Follow semantic versioning
+- **QBit Pattern**: Follow QBit component architecture
+
+**First time contributing?** Start with our [Developer Onboarding Guide](https://github.com/Kingsrook/qqq/wiki/Developer-Onboarding) to get your environment set up.
+
+## 🏢 About Kingsrook
+
+QBit Workflows is built by **[Kingsrook](https://qrun.io)** - making engineers more productive through intelligent automation and developer tools.
+
+- **Website**: [https://qrun.io](https://qrun.io)
+- **Contact**: [contact@kingsrook.com](mailto:contact@kingsrook.com)
+- **GitHub**: [https://github.com/Kingsrook](https://github.com/Kingsrook)
+
+## 📄 License
+
+This project is licensed under the **GNU Affero General Public License v3.0** - see the [LICENSE.txt](LICENSE.txt) file for details.
+
+---
+
+**Ready to build workflows with full control?** [Get started with QQQ today!](https://github.com/Kingsrook/qqq/wiki/Developer-Onboarding)
+

SECURITY.md

@@ -0,0 +1,3 @@
+# Security Policy
+ 
+ * See Project [Security Policy](https://github.com/Kingsrook/qqq/blob/develop/SECURITY.md)

pom.xml

@@ -21,37 +21,53 @@
   -->
 
 <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">
-   <modelVersion>4.0.0</modelVersion>
+   
+   <properties>
+      <revision>0.3.0-SNAPSHOT</revision>
+   </properties>
+
+   <parent>
+      <groupId>com.kingsrook</groupId>
+      <artifactId>qbit-build-parent</artifactId>
+      <version>1.4.0</version>
+   </parent>
 
    <groupId>com.kingsrook.qbits</groupId>
    <artifactId>qbit-workflows</artifactId>
-   <version>0.1.13-SNAPSHOT</version>
+   <version>${revision}</version>
+   <packaging>jar</packaging>
 
-   <properties>
-      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-      <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-      <maven.compiler.release>17</maven.compiler.release>
-      <maven.compiler.target>17</maven.compiler.target>
-   </properties>
+   <name>QBit Workflows</name>
+   <description>Workflow management and process automation module for the QBit framework</description>
+   <url>https://github.com/Kingsrook/qbit-workflows</url>
+
+   <licenses>
+      <license>
+         <name>GNU Affero General Public License v3.0</name>
+         <url>https://www.gnu.org/licenses/agpl-3.0.html</url>
+         <distribution>repo</distribution>
+      </license>
+   </licenses>
+
+   <modelVersion>4.0.0</modelVersion>
+
+   <developers>
+      <developer>
+         <id>kingsrook</id>
+         <name>Kingsrook Team</name>
+         <email>contact@kingsrook.com</email>
+         <organization>Kingsrook, LLC</organization>
+         <organizationUrl>https://kingsrook.com</organizationUrl>
+      </developer>
+   </developers>
+
+   <scm>
+      <connection>scm:git:git://github.com/Kingsrook/qbit-workflows.git</connection>
+      <developerConnection>scm:git:ssh://github.com:Kingsrook/qbit-workflows.git</developerConnection>
+      <url>https://github.com/Kingsrook/qbit-workflows</url>
+      <tag>HEAD</tag>
+   </scm>
 
-   <dependencyManagement>
-      <dependencies>
-         <dependency>
-            <groupId>com.kingsrook.qqq</groupId>
-            <artifactId>qqq-bom-pom</artifactId>
-            <version>0.27.9</version>
-            <type>pom</type>
-            <scope>import</scope>
-         </dependency>
-         <dependency>
-            <groupId>org.junit</groupId>
-            <artifactId>junit-bom</artifactId>
-            <version>5.10.0</version>
-            <type>pom</type>
-            <scope>import</scope>
-         </dependency>
-      </dependencies>
-   </dependencyManagement>
 
    <dependencies>
       <dependency>
@@ -71,7 +87,7 @@
       <dependency>
          <groupId>com.kingsrook.qqq</groupId>
          <artifactId>qqq-frontend-material-dashboard</artifactId>
-         <version>0.27.0-20250915.210441-5</version>
+         <version>0.27.0-RC.1</version>
       </dependency>
 
       <dependency>
@@ -87,24 +103,4 @@
       </dependency>
    </dependencies>
 
-   <repositories>
-      <repository>
-         <id>sonatype-snapshots</id>
-         <url>https://central.sonatype.com/repository/maven-snapshots/</url>
-      </repository>
-      <repository>
-         <id>github-qqq-maven-registry</id>
-         <name>GitHub QQQ Maven Registry</name>
-         <url>https://maven.pkg.github.com/Kingsrook/qqq-maven-registry</url>
-      </repository>
-   </repositories>
-
-   <distributionManagement>
-      <repository>
-         <id>github-qqq-maven-registry</id>
-         <name>GitHub QQQ Maven Registry</name>
-         <url>https://maven.pkg.github.com/Kingsrook/qqq-maven-registry</url>
-      </repository>
-   </distributionManagement>
-
 </project>