Add .circleci/config.yml

2026-09-26 01:09:14 -05:00
13 changed files with 103 additions and 198 deletions
@@ -1,14 +1,31 @@
+# Use the latest 2.1 version of CircleCI pipeline process engine.
+# See: https://circleci.com/docs/reference/configuration-reference/
 version: 2.1
-setup: true
-orbs:
-  qqq-orb: kingsrook/qqq-orb@0.8
+
+# Define a job to be invoked later in a workflow.
+# See: https://circleci.com/docs/guides/orchestrate/jobs-steps/#jobs-overview & https://circleci.com/docs/reference/configuration-reference/#jobs
+jobs:
+  say-hello:
+    # Specify the execution environment. You can specify an image from Docker Hub or use one of our convenience images from CircleCI's Developer Hub.
+    # See: https://circleci.com/docs/guides/execution-managed/executor-intro/ & https://circleci.com/docs/reference/configuration-reference/#executor-job
+    docker:
+      # Specify the version you desire here
+      # See: https://circleci.com/developer/images/image/cimg/base
+      - image: cimg/base:current
+
+    # Add steps to the job
+    # See: https://circleci.com/docs/guides/orchestrate/jobs-steps/#steps-overview & https://circleci.com/docs/reference/configuration-reference/#steps
+    steps:
+      # Checkout the code as the first step.
+      - checkout
+      - run:
+          name: "Say hello"
+          command: "echo Hello, World!"
+
+# Orchestrate jobs using workflows
+# See: https://circleci.com/docs/guides/orchestrate/workflows/ & https://circleci.com/docs/reference/configuration-reference/#workflows
 workflows:
-  setup:
+  say-hello-workflow: # This is the name of the workflow, feel free to change it to better match your workflow.
+    # Inside the workflow, you define the jobs you want to run.
    jobs:
-    - qqq-orb/generate_pipeline:
-        orb_version: '0.8'
-        filters:
-          branches:
-            ignore: automation/qbit-rc-pending
-          tags:
-            only: /.*/
+      - say-hello
@@ -1,9 +0,0 @@
-name: build
-on:
-  push:
-jobs:
-  maven:
-    uses: self:KofTwentyTwo/ci-workflows/.gitea/workflows/maven.yaml@v1
-    secrets: inherit
-    with:
-      publish: false
@@ -1,3 +0,0 @@
-profile: app-starter
-orb_version: '0.8'
-default_branch: main
@@ -24,6 +24,7 @@ Key facts from that review:
  `QInstance.setAuthentication(...)` (removed; use
  `withInstanceDefaultAuthentication` / `registerAuthenticationProvider`), and
  the pom pins Java 17 vs 4.0's Java 21 floor.
- The historical license split is resolved in the current source: LICENSE/NOTICE,
-  source headers, the pom header and `<licenses>` metadata, and
-  `checkstyle/license.txt` consistently declare Apache-2.0.
+- Licensing is split: LICENSE/NOTICE say Apache-2.0, but source headers, the
+  pom header, and the checkstyle-enforced header template
+  (`checkstyle/license.txt`) are still AGPL-3.0/Kingsrook; pom has no
+  `<licenses>` block.
@@ -53,21 +53,4 @@ For migration changes, see the [QQQ 4.0 migration guide](https://github.com/QRun

 ## License

-The packaged application includes byte-for-byte copies of this repository's
-`LICENSE` and `NOTICE` under `META-INF/qqq-app-starter/`. This namespace avoids
-overwriting dependency license/notice entries during shading. Main/test resources
-and Maven shared resources for source/Javadoc archives include the same copies.
-
-After packaging, use Python 3 to check every produced archive explicitly:
-
-```bash
-mvn -DskipTests clean package
-python3 scripts/check-packaged-notices.py --root . --prefix META-INF/qqq-app-starter target/*.jar
-```
-
-This is a packaging-only check; existing runtime tests, reviews and release
-requirements still apply. The guard rejects absent archives, missing/duplicate
-entries and altered notice bytes. It checks the supplied archives; it does not
-generate additional classifiers or run automatically in the publishing workflow.
-
-Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
+See [LICENSE](LICENSE) and [NOTICE](NOTICE).
@@ -6,17 +6,18 @@
  ~ contact@kingsrook.com
  ~ https://github.com/Kingsrook/
  ~
-  ~ 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 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.
  ~
-  ~     https://www.apache.org/licenses/LICENSE-2.0
+  ~ 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.
  ~
-  ~ 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.
+  ~ 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/>.
  -->

 <!DOCTYPE module PUBLIC
@@ -5,15 +5,16 @@
 * contact@kingsrook.com
 * https://github.com/Kingsrook/
 *
- * 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 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.
 *
- *     https://www.apache.org/licenses/LICENSE-2.0
+ * 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.
 *
- * 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.
+ * 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/>.
 */
@@ -6,17 +6,18 @@
  ~ contact@kingsrook.com
  ~ https://github.com/Kingsrook/
  ~
-  ~ 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 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.
  ~
-  ~     https://www.apache.org/licenses/LICENSE-2.0
+  ~ 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.
  ~
-  ~ 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.
+  ~ 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/>.
  -->

 <project xmlns="http://maven.apache.org/POM/4.0.0"
@@ -28,14 +29,6 @@
   <artifactId>qqq-app-starter</artifactId>
   <version>0.1-SNAPSHOT</version>

-   <licenses>
-      <license>
-         <name>Apache License, Version 2.0</name>
-         <url>https://www.apache.org/licenses/LICENSE-2.0</url>
-         <distribution>repo</distribution>
-      </license>
-   </licenses>
-
   <properties>
      <!-- props specifically to this module -->
      <!-- none at this time -->
@@ -130,51 +123,7 @@
   </dependencies>

   <build>
-      <resources>
-         <resource>
-            <directory>src/main/resources</directory>
-         </resource>
-         <resource>
-            <directory>${project.build.directory}/maven-shared-archive-resources</directory>
-         </resource>
-      </resources>
-      <testResources>
-         <testResource>
-            <directory>src/test/resources</directory>
-         </testResource>
-         <testResource>
-            <directory>${project.build.directory}/maven-shared-archive-resources</directory>
-         </testResource>
-      </testResources>
      <plugins>
-         <!-- Namespace our exact copies so shading preserves dependency notices. -->
-         <plugin>
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-resources-plugin</artifactId>
-            <version>3.4.0</version>
-            <executions>
-               <execution>
-                  <id>package-root-notices</id>
-                  <phase>generate-resources</phase>
-                  <goals>
-                     <goal>copy-resources</goal>
-                  </goals>
-                  <configuration>
-                     <outputDirectory>${project.build.directory}/maven-shared-archive-resources/META-INF/qqq-app-starter</outputDirectory>
-                     <resources>
-                        <resource>
-                           <directory>${project.basedir}</directory>
-                           <filtering>false</filtering>
-                           <includes>
-                              <include>LICENSE</include>
-                              <include>NOTICE</include>
-                           </includes>
-                        </resource>
-                     </resources>
-                  </configuration>
-               </execution>
-            </executions>
-         </plugin>
         <!-- Assembly plugin, for building a CLI-->
         <plugin>
            <artifactId>maven-assembly-plugin</artifactId>
@@ -1,39 +0,0 @@
-#!/usr/bin/env python3
-"""Verify exact project notices in explicitly listed Maven archives."""
-
-import argparse
-from pathlib import Path
-import sys
-from zipfile import BadZipFile, ZipFile
-
-
-def main():
-    parser = argparse.ArgumentParser(description=__doc__)
-    parser.add_argument("--root", type=Path, required=True,
-                        help="consumer repository containing LICENSE and NOTICE")
-    parser.add_argument("--prefix", default="META-INF",
-                        help="directory containing the project's archive copies")
-    parser.add_argument("archives", type=Path, nargs="+")
-    args = parser.parse_args()
-    expected = {name: (args.root / name).read_bytes() for name in ("LICENSE", "NOTICE")}
-    failures = []
-    for archive in args.archives:
-        try:
-            with ZipFile(archive) as jar:
-                for name, content in expected.items():
-                    entry = f"{args.prefix.rstrip('/')}/{name}"
-                    if jar.namelist().count(entry) != 1:
-                        failures.append(f"{archive}: expected exactly one {entry}")
-                    elif jar.read(entry) != content:
-                        failures.append(f"{archive}: {entry} differs from root {name}")
-        except (OSError, BadZipFile) as error:
-            failures.append(f"{archive}: {error}")
-    if failures:
-        print("\n".join(failures), file=sys.stderr)
-        return 1
-    print(f"PASS: exact LICENSE/NOTICE in {len(args.archives)} archives")
-    return 0
-
-
-if __name__ == "__main__":
-    sys.exit(main())
@@ -5,17 +5,18 @@
 * contact@kingsrook.com
 * https://github.com/Kingsrook/
 *
- * 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 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.
 *
- *     https://www.apache.org/licenses/LICENSE-2.0
+ * 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.
 *
- * 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.
+ * 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/>.
 */

 package com.kingsrook.qqq.starterapp;
@@ -5,17 +5,18 @@
 * contact@kingsrook.com
 * https://github.com/Kingsrook/
 *
- * 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 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.
 *
- *     https://www.apache.org/licenses/LICENSE-2.0
+ * 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.
 *
- * 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.
+ * 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/>.
 */

 package com.kingsrook.qqq.starterapp;
@@ -5,17 +5,18 @@
 * contact@kingsrook.com
 * https://github.com/Kingsrook/
 *
- * 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 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.
 *
- *     https://www.apache.org/licenses/LICENSE-2.0
+ * 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.
 *
- * 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.
+ * 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/>.
 */

 package com.kingsrook.qqq.starterapp;
@@ -5,17 +5,18 @@
 * contact@kingsrook.com
 * https://github.com/Kingsrook/
 *
- * 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 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.
 *
- *     https://www.apache.org/licenses/LICENSE-2.0
+ * 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.
 *
- * 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.
+ * 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/>.
 */

 package com.kingsrook.qqq.starterapp;