From 5935331c3197a4522229b091858494d0236338e7 Mon Sep 17 00:00:00 2001
From: James Maes <james@kof22.com>
Date: Tue, 16 Sep 2025 16:44:50 -0500
Subject: [PATCH] chore: Updated to meet requirements for maven central and
 qqq-orb

---
 .circleci/config.yml       |  95 ++++++++++++++++-----------------
 .circleci/mvn-settings.xml |   9 ----
 CHANGELOG.md               |  58 ++++++++++++++++++++
 CODE_OF_CONDUCT.md         |   4 ++
 CODE_STYLE.md              |   3 ++
 CONTRIBUTING.md            |   4 ++
 README.md                  | 100 ++++++++++++++++++++++++++++++++++-
 SECURITY.md                |   3 ++
 pom.xml                    | 105 ++++++++++++++-----------------------
 9 files changed, 258 insertions(+), 123 deletions(-)
 delete mode 100644 .circleci/mvn-settings.xml
 create mode 100644 CHANGELOG.md
 create mode 100644 CODE_OF_CONDUCT.md
 create mode 100644 CODE_STYLE.md
 create mode 100644 CONTRIBUTING.md
 create mode 100644 SECURITY.md

diff --git a/.circleci/config.yml b/.circleci/config.yml
index 41973ad..ed1e21c 100644
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@@ -1,56 +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.5
 
 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
-      - 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
+              only:
+                - 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:
+              only: [ main ]
+            tags:
+              only: [ /v.*/ ]
+
+  publish_hotfix_release:
+    jobs:
+      - qqq-orb/mvn_publish:
+          context: [ qqq-maven-registry-credentials ]
+          branch_type: hotfix
+          filters:
+            branches:
+              only:
+                - /hotfix\/.*/
diff --git a/.circleci/mvn-settings.xml b/.circleci/mvn-settings.xml
deleted file mode 100644
index b2a345f..0000000
--- a/.circleci/mvn-settings.xml
+++ /dev/null
@@ -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>
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..2fe902f
--- /dev/null
+++ b/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!** 🚀
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..c079e2b
--- /dev/null
+++ b/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)
diff --git a/CODE_STYLE.md b/CODE_STYLE.md
new file mode 100644
index 0000000..a1cf983
--- /dev/null
+++ b/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)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..470372b
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,4 @@
+# Contributing to QBit User Role Permissions
+
+* See Project [Contributing](https://github.com/Kingsrook/qqq/blob/develop/CONTRIBUTING.md)
+
diff --git a/README.md b/README.md
index adeb9ac..9460c98 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,8 @@
-# QBit:  SFTP Data Integration
+# QBit: SFTP Data Integration
+
+[![Version](https://img.shields.io/badge/version-0.1.0-blue.svg)](https://github.com/Kingsrook/qbit-sftp-data-integration)
+[![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
@@ -28,6 +32,14 @@ The architecture of such an integration looks like:
       as the destination for files to be imported.
     * A process that renders saved reports, writing their contents to the destination SFTP backend.
 
+## Prerequisites
+
+- **Java 17+** (required for QQQ features)
+- **Maven 3.8+** (for build system)
+- **QQQ Framework** (qqq-backend-module-filesystem >= 0.24.0 for SFTP support)
+- **Active Quartz Scheduler** in your QQQ instance for running scheduled cron jobs
+- **Scheduled Jobs table** in your QQQ instance
+
 ## Usage
 
 ### Pom dependency
@@ -134,3 +146,89 @@ public class ImportFileBulkLoadQBitMetaDataLoader extends MetaDataProducer<MetaD
 * Meta-data objects produced by `SavedBulkLoadProfileMetaDataProvider` from qqq-backend-core.
 * Meta-data objects produced by `SavedReportsMetaDataProvider` from qqq-backend-core.
 
+## 🤝 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
+
+## 📄 License
+
+This project is licensed under the GNU Affero General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
+
+```
+QBit: SFTP Data Integration
+Copyright (C) 2021-2024 Kingsrook, LLC
+651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
+contact@kingsrook.com | https://github.com/Kingsrook/
+```
+
+**Note**: This is a component of the QQQ framework. For the complete license and more information, see the main QQQ repository: https://github.com/Kingsrook/qqq
+
+## 🏢 About Kingsrook
+
+QBit: SFTP Data Integration 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)
+
+## 🆘 Support & Community
+
+### ⚠️ Important: Use Main QQQ Repository
+
+**All support, issues, discussions, and community interactions should go through the main QQQ repository:**
+
+- **Main Repository**: https://github.com/Kingsrook/qqq
+- **Issues**: https://github.com/Kingsrook/qqq/issues
+- **Discussions**: https://github.com/Kingsrook/qqq/discussions
+- **Wiki**: https://github.com/Kingsrook/qqq.wiki
+
+### Why This Repository Exists
+
+This repository is maintained separately from the main QQQ repository to:
+- **Enable independent QBit development** and versioning
+- **Allow QBit-specific CI/CD** and deployment pipelines
+- **Provide clear separation** between QBit components and core framework concerns
+- **Support different release cycles** for QBits vs. core framework
+
+### Getting Help
+
+- **Documentation**: Check the [QQQ Wiki](https://github.com/Kingsrook/qqq.wiki)
+- **Issues**: Report bugs and feature requests on [Main QQQ Issues](https://github.com/Kingsrook/qqq/issues)
+- **Discussions**: Join community discussions on [Main QQQ Discussions](https://github.com/Kingsrook/qqq/discussions)
+- **Questions**: Ask questions in the main QQQ repository
+
+### Contact Information
+
+- **Company**: Kingsrook, LLC
+- **Email**: contact@kingsrook.com
+- **Website**: https://kingsrook.com
+- **Main GitHub**: https://github.com/Kingsrook/qqq
+
+## 🙏 Acknowledgments
+
+- **QQQ Framework Team**: For the underlying low-code platform
+- **Maven Community**: For the robust build system
+- **Open Source Community**: For the tools and libraries that make this possible
+
+---
+
+**Built with ❤️ by the Kingsrook Team**
+
+**This is a QBit component of the QQQ framework. For complete information, support, and community, visit: https://github.com/Kingsrook/qqq**
+
diff --git a/SECURITY.md b/SECURITY.md
new file mode 100644
index 0000000..44e3e7b
--- /dev/null
+++ b/SECURITY.md
@@ -0,0 +1,3 @@
+# Security Policy
+ 
+ * See Project [Security Policy](https://github.com/Kingsrook/qqq/blob/develop/SECURITY.md)
diff --git a/pom.xml b/pom.xml
index 0f1e0cf..e18a610 100644
--- a/pom.xml
+++ b/pom.xml
@@ -23,26 +23,52 @@
 <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>
 
+   <parent>
+      <groupId>com.kingsrook</groupId>
+      <artifactId>qbit-build-parent</artifactId>
+      <version>1.1.0</version>
+   </parent>
+
    <groupId>com.kingsrook.qbits</groupId>
    <artifactId>qbit-sftp-data-integration</artifactId>
-   <version>0.1.2</version>
+   <version>${revision}</version>
+   <packaging>jar</packaging>   
+
+   <name>QBit: SFTP Data Integration</name>
+   <description>SFTP-based data integration QBit for the QQQ framework, providing file import/export capabilities using SFTP servers</description>
+   <url>https://github.com/Kingsrook/qbit-sftp-data-integration</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>
+
+   <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-sftp-data-integration.git</connection>
+      <developerConnection>scm:git:ssh://github.com:Kingsrook/qbit-sftp-data-integration.git</developerConnection>
+      <url>https://github.com/Kingsrook/qbit-sftp-data-integration</url>
+      <tag>HEAD</tag>
+   </scm>
 
    <properties>
-      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-      <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-      <maven.compiler.source>17</maven.compiler.source>
-      <maven.compiler.target>17</maven.compiler.target>
+      <revision>0.2.0-SNAPSHOT</revision>
    </properties>
 
-   <dependencyManagement>
+ <dependencyManagement>
       <dependencies>
-         <dependency>
-            <groupId>com.kingsrook.qqq</groupId>
-            <artifactId>qqq-bom-pom</artifactId>
-            <version>0.24.0-integration-sprint-61-20250226-223322</version>
-            <type>pom</type>
-            <scope>import</scope>
-         </dependency>
          <dependency>
             <groupId>org.junit</groupId>
             <artifactId>junit-bom</artifactId>
@@ -75,57 +101,4 @@
       </dependency>
    </dependencies>
 
-   <build>
-      <plugins>
-         <plugin>
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-checkstyle-plugin</artifactId>
-            <version>3.1.2</version>
-            <dependencies>
-               <dependency>
-                  <groupId>com.puppycrawl.tools</groupId>
-                  <artifactId>checkstyle</artifactId>
-                  <version>10.16.0</version>
-               </dependency>
-            </dependencies>
-            <executions>
-               <execution>
-                  <id>validate</id>
-                  <phase>validate</phase>
-                  <configuration>
-                     <configLocation>checkstyle/config.xml</configLocation>
-                     <headerLocation>checkstyle/license.txt</headerLocation>
-                     <encoding>UTF-8</encoding>
-                     <consoleOutput>true</consoleOutput>
-                     <failsOnError>false</failsOnError>
-                     <failOnViolation>true</failOnViolation>
-                     <violationSeverity>warning</violationSeverity>
-                     <excludes>**/target/generated-sources/*.*</excludes>
-                     <includeTestSourceDirectory>true</includeTestSourceDirectory>
-                  </configuration>
-                  <goals>
-                     <goal>check</goal>
-                  </goals>
-               </execution>
-            </executions>
-         </plugin>
-      </plugins>
-   </build>
-
-   <repositories>
-      <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>
-- 
2.54.0