Merge pull request #62 from coldbox-modules/development

v4.5.0

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+---
+
+<!-- Thanks for reporting an issue! Please fill out the blanks below. -->
+
+## What are the steps to reproduce this issue?
+
+1. …
+2. …
+3. …
+
+## What happens?
+
+…
+
+## What were you expecting to happen?
+
+…
+
+## Any logs, error output, etc?
+
+…
+
+## Any other comments?
+
+…
+
+## What versions are you using?
+
+**Operating System:** …
+**Package Version:** …

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -0,0 +1,18 @@
+---
+name: Feature Request
+about: Request a new feature or enhancement
+---
+
+<!-- Thanks for taking the time to recommend a feature! Please fill out the form below -->
+
+## Summary
+
+<!-- High level description of what this feature is -->
+
+## Detailed Description
+
+<!-- Lets get into the weeds here -->
+
+## Possible Implementation Ideas
+
+<!-- If you already have some idea of how to implement this, this would be the place to put it -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,29 @@
+# Description
+
+Please include a summary of the changes and which issue(s) is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+**Please note that all PRs must have tests attached to them**
+
+IMPORTANT: Please review the [CONTRIBUTING.md](../CONTRIBUTING.md) file for detailed contributing guidelines.
+
+## Issues
+
+All PRs must have an accompanied issue. Please make sure you created it and linked it here.
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug Fix
+- [ ] Improvement
+- [ ] New Feature
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+## Checklist
+
+- [ ] My code follows the style guidelines of this project [cfformat](../.cfformat.json)
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes

.github/workflows/release.yml

@@ -29,7 +29,7 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup CommandBox
         uses: Ortus-Solutions/setup-commandbox@v2.0.1
@@ -50,19 +50,21 @@ jobs:
           fi
 
       - name: Update changelog [unreleased] with latest version
-        uses: thomaseizinger/keep-a-changelog-new-release@1.3.0
+        uses: thomaseizinger/keep-a-changelog-new-release@3.0.0
         if: env.SNAPSHOT == 'false'
         with:
           changelogPath: ./changelog.md
           tag: v${{ env.VERSION }}
 
       - name: Build ${{ env.MODULE_ID }}
         run: |
+          npm install -g markdownlint-cli
+          markdownlint changelog.md --fix
           box install commandbox-docbox
           box task run taskfile=build/Build target=run :version=${{ env.VERSION }} :projectName=${{ env.MODULE_ID }} :buildID=${{ github.run_number }} :branch=${{ env.BRANCH }}
 
       - name: Commit Changelog To Master
-        uses: EndBug/add-and-commit@v9.1.1
+        uses: EndBug/add-and-commit@v9.1.4
         if: env.SNAPSHOT == 'false'
         with:
           author_name: Github Actions
@@ -71,7 +73,7 @@ jobs:
           add: changelog.md
 
       - name: Tag Version
-        uses: rickstaa/action-create-tag@v1.6.1
+        uses: rickstaa/action-create-tag@v1.7.2
         if: env.SNAPSHOT == 'false'
         with:
           tag: "v${{ env.VERSION }}"
@@ -80,19 +82,43 @@ jobs:
 
       - name: Upload Build Artifacts
         if: success()
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ env.MODULE_ID }}
           path: |
             .artifacts/**/*
             changelog.md
 
+      - name: Upload Binaries to S3
+        uses: jakejarvis/s3-sync-action@master
+        with:
+          args: --acl public-read
+        env:
+          AWS_S3_BUCKET: "downloads.ortussolutions.com"
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_ACCESS_SECRET }}
+          SOURCE_DIR: ".artifacts/${{ env.MODULE_ID }}"
+          DEST_DIR: "ortussolutions/coldbox-modules/${{ env.MODULE_ID }}"
+
+      - name: Upload API Docs to S3
+        uses: jakejarvis/s3-sync-action@master
+        with:
+          args: --acl public-read
+        env:
+          AWS_S3_BUCKET: "apidocs.ortussolutions.com"
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_ACCESS_SECRET }}
+          SOURCE_DIR: ".tmp/apidocs"
+          DEST_DIR: "coldbox-modules/${{ env.MODULE_ID }}/${{ env.VERSION }}"
+
       - name: Publish To ForgeBox
         run: |
-          cd .tmp/${{ env.MODULE_ID }} && box forgebox publish --force
+          cd .tmp/${{ env.MODULE_ID }}
+          cat box.json
+          box forgebox publish --force
 
       - name: Create Github Release
-        uses: taiki-e/create-gh-release-action@v1.6.2
+        uses: taiki-e/create-gh-release-action@v1.8.2
         continue-on-error: true
         if: env.SNAPSHOT == 'false'
         with:
@@ -112,7 +138,7 @@ jobs:
     steps:
       # Checkout development
       - name: Checkout Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: development
 
@@ -122,7 +148,7 @@ jobs:
           forgeboxAPIKey: ${{ secrets.FORGEBOX_TOKEN }}
 
       - name: Download build artifacts
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4
         with:
           name: ${{ env.MODULE_ID }}
           path: .tmp
@@ -139,7 +165,7 @@ jobs:
 
       # Commit it back to development
       - name: Commit Version Bump
-        uses: EndBug/add-and-commit@v9.1.1
+        uses: EndBug/add-and-commit@v9.1.4
         with:
           author_name: Github Actions
           author_email: info@ortussolutions.com

.github/workflows/tests.yml

@@ -18,26 +18,25 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        cfengine: [ "lucee@5", "adobe@2018", "adobe@2021" ]
-        coldboxVersion: [ "^6.0.0" ]
+        cfengine: [ "lucee@5", "adobe@2018", "adobe@2021", "adobe@2023" ]
+        coldboxVersion: [ "^6.0.0", "^7.0.0" ]
         experimental: [ false ]
         include:
-          - cfengine: "lucee-hibernate@5.4"
-            coldboxVersion: "^6.0.0"
-            experimental: true
           - coldboxVersion: "be"
             cfengine: "lucee@5"
             experimental: true
           - coldboxVersion: "be"
-            cfengine: "adobe@2018"
+            cfengine: "lucee@6"
+            experimental: true
+          - coldboxVersion: "be"
+            cfengine: "adobe@2023"
             experimental: true
           - coldboxVersion: "be"
             cfengine: "adobe@2021"
             experimental: true
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v3
-
+        uses: actions/checkout@v4
 
       - name: Setup Java
         uses: actions/setup-java@v3
@@ -95,7 +94,7 @@ jobs:
 
       - name: Upload Test Results to Artifacts
         if: always()
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: test-results-${{ matrix.cfengine }}-${{ matrix.coldboxVersion }}
           path: |
@@ -108,7 +107,7 @@ jobs:
 
       - name: Upload Debug Logs To Artifacts
         if: ${{ failure() }}
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: Failure Debugging Info - ${{ matrix.cfengine }} - ${{ matrix.coldboxVersion }}
           path: |

.markdownlint.json

@@ -8,8 +8,7 @@
 	"no-multiple-blanks": {
 		"maximum": 2
 	},
-	"no-duplicate-header" : {
-		"siblings_only" : true
-	},
+	"no-duplicate-header" : false,
+	"no-duplicate-heading" : false,
 	"no-inline-html" : false
 }

.vscode/tasks.json

@@ -0,0 +1,33 @@
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"label": "Run CommandBox Task",
+			"type": "shell",
+			"command": "box task run ${relativeFile}",
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			},
+			"presentation": {
+				"reveal": "always",
+				"panel": "new"
+			},
+			"problemMatcher": []
+		},
+		{
+			"label": "Run TestBox Bundle",
+			"type": "shell",
+			"command": "box testbox run bundles=${relativeFile} --!recurse",
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			},
+			"presentation": {
+				"reveal": "always",
+				"panel": "new"
+			},
+			"problemMatcher": []
+		}
+	]
+}

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# CBSecurity Contributing Guide
+# cborm Contributing Guide
 
 Hola amigo! I'm really excited that you are interested in contributing to our project. Before submitting your contribution, please make sure to take a moment and read through the following guidelines:
 
@@ -27,7 +27,7 @@ This project is open source, and as such, the maintainers give their free time t
 
 Each of the main standalone frameworks in ColdBox has its separate locations for submitting bug reports.  Please make sure also that if you submit a pull request, you link it to the appropriate issue.
 
-https://github.com/coldbox-modules/cbsecurity
+https://github.com/coldbox-modules/cborm
 
 If you file a bug report, your issue should contain a title, a clear description of the issue, a way to replicate the issue, and any support files that we might need to replicate your issue. The goal of a bug report is to make it easy for yourself - and others - to replicate the bug and develop a fix for it.  All issues that do not contain a way to replicate will not be addressed.
 
@@ -81,8 +81,8 @@ You can support ColdBox and all of our Open Source initiatives at Ortus Solution
 
 Thank you to all the people who have already contributed to ColdBox! We: heart: : heart: : heart: love you!
 
-<a   href = "https://github.com/coldbox-modules/cbsecurity/graphs/contributors">
-<img src  = "https://contrib.rocks/image?repo=coldbox-modules/cbsecurity"/>
+<a   href = "https://github.com/coldbox-modules/cborm/graphs/contributors">
+<img src  = "https://contrib.rocks/image?repo=coldbox-modules/cborm"/>
 </a>
 
 Made with [contributors-img](https://contrib.rocks)

box.json

@@ -1,6 +1,6 @@
 {
     "name":"ColdBox ORM Extensions",
-    "version":"4.4.0",
+    "version":"4.5.0",
     "location":"https://downloads.ortussolutions.com/ortussolutions/coldbox-modules/cborm/@build.version@/cborm-@build.version@.zip",
     "author":"Ortus Solutions <info@ortussolutions.com",
     "homepage":"https://github.com/coldbox-modules/cborm",
@@ -54,15 +54,18 @@
         "format:check":"cfformat check aop,dsl,interceptors,models,test-harness/tests/,ModuleConfig.cfc ./.cfformat.json",
         "install:dependencies":"install && cd test-harness && install",
         "startdbs":"!docker-compose -f docker-compose.yml up",
-		"start:lucee" : "server start serverConfigFile=server-lucee@5.json",
-		"start:2018" : "server start serverConfigFile=server-adobe@2018.json",
-		"start:2021" : "server start serverConfigFile=server-adobe@2021.json",
-		"stop:lucee" : "server stop serverConfigFile=server-lucee@5.json",
-		"stop:2018" : "server stop serverConfigFile=server-adobe@2018.json",
-		"stop:2021" : "server stop serverConfigFile=server-adobe@2021.json",
-		"logs:lucee" : "server log serverConfigFile=server-lucee@5.json --follow",
-		"logs:2018" : "server log serverConfigFile=server-adobe@2018.json --follow",
-		"logs:2021" : "server log serverConfigFile=server-adobe@2021.json --follow"
+        "start:lucee":"server start serverConfigFile=server-lucee@5.json",
+        "start:2018":"server start serverConfigFile=server-adobe@2018.json",
+        "start:2021":"server start serverConfigFile=server-adobe@2021.json",
+		"start:2023":"server start serverConfigFile=server-adobe@2023.json",
+        "stop:lucee":"server stop serverConfigFile=server-lucee@5.json",
+        "stop:2018":"server stop serverConfigFile=server-adobe@2018.json",
+        "stop:2021":"server stop serverConfigFile=server-adobe@2021.json",
+		"stop:2023":"server stop serverConfigFile=server-adobe@2023.json",
+        "logs:lucee":"server log serverConfigFile=server-lucee@5.json --follow",
+        "logs:2018":"server log serverConfigFile=server-adobe@2018.json --follow",
+        "logs:2021":"server log serverConfigFile=server-adobe@2021.json --follow",
+		"logs:2023":"server log serverConfigFile=server-adobe@2023.json --follow"
     },
     "installPaths":{
         "cbvalidation":"modules/cbvalidation/",

build/Build.cfc

@@ -12,6 +12,7 @@ component {
 		variables.cwd          = getCWD().reReplace( "\.$", "" );
 		variables.artifactsDir = cwd & "/.artifacts";
 		variables.buildDir     = cwd & "/.tmp";
+		variables.apidDocsDir = variables.buildDir & "/apidocs";
 		variables.apiDocsURL   = "http://localhost:60299/apidocs/";
 		variables.testRunner   = "http://localhost:60299/tests/runner.cfm";
 
@@ -31,7 +32,8 @@ component {
 		// Cleanup + Init Build Directories
 		[
 			variables.buildDir,
-			variables.artifactsDir
+			variables.artifactsDir,
+			variables.apidDocsDir
 		].each( function( item ){
 			if ( directoryExists( item ) ) {
 				directoryDelete( item, true );