Skip to content

Commit

Permalink
Merge branch 'development'
Browse files Browse the repository at this point in the history
  • Loading branch information
lmajano committed Jan 10, 2024
2 parents 9bc46a4 + fef0d41 commit 32d096b
Show file tree
Hide file tree
Showing 65 changed files with 2,564 additions and 1,023 deletions.
Binary file added .DS_Store
Binary file not shown.
4 changes: 3 additions & 1 deletion .cfconfig.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
{
"adminPassword" : "coldbox",
"debuggingEnabled":true,
"debuggingDBEnabled":"true",
"debuggingEnabled":"true",
"debuggingShowDatabase" : true,
"debuggingReportExecutionTimes":false,
"disableInternalCFJavaComponents":false,
"inspectTemplate":"always",
Expand Down
3 changes: 3 additions & 0 deletions .github/CODE_OF_CONDUCT.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Code of Conduct

Please see it in our [Contributing Guidelines](../CONTRIBUTING.md#code-of-conduct).
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -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:**
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
@@ -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 -->
29 changes: 29 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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
3 changes: 3 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Security Policy

Please see it in our [Contributing Guidelines](../CONTRIBUTING.md#security-vulnerabilities).
3 changes: 3 additions & 0 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Support & Help

Please see it in our [Contributing Guidelines](../CONTRIBUTING.md#support-questions).
2 changes: 1 addition & 1 deletion .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
runs-on: ubuntu-20.04
steps:
- name: Checkout Repository
uses: actions/checkout@v3
uses: actions/checkout@v4

- uses: Ortus-Solutions/commandbox-action@v1.0.2
with:
Expand Down
49 changes: 37 additions & 12 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ jobs:
runs-on: ubuntu-20.04
steps:
- name: Checkout Repository
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Setup nodejs
uses: actions/setup-node@v2
uses: actions/setup-node@v4
with:
node-version: 16.x
node-version: 18.x

- name: Setup CommandBox
uses: Ortus-Solutions/setup-commandbox@v2.0.1
Expand Down Expand Up @@ -63,15 +63,16 @@ jobs:

- name: Build ${{ env.MODULE_ID }}
run: |
npm i npm@latest -g
npm install
npm run prod
rm -Rf node_modules
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.3
if: env.SNAPSHOT == 'false'
with:
author_name: Github Actions
Expand All @@ -80,7 +81,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 }}"
Expand All @@ -89,19 +90,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.0
continue-on-error: true
if: env.SNAPSHOT == 'false'
with:
Expand All @@ -121,7 +146,7 @@ jobs:
steps:
# Checkout development
- name: Checkout Repository
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
ref: development

Expand All @@ -131,7 +156,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
Expand All @@ -148,7 +173,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.3
with:
author_name: Github Actions
author_email: info@ortussolutions.com
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/snapshot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ jobs:
name: Code Auto-Formatting
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- name: Auto-format
uses: Ortus-Solutions/commandbox-action@v1.0.2
with:
cmd: run-script format

- name: Commit Format Changes
uses: stefanzweifel/git-auto-commit-action@v4
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: Apply cfformat changes

Expand Down
15 changes: 9 additions & 6 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ 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:
- coldboxVersion: "be"
Expand All @@ -31,13 +31,16 @@ jobs:
- coldboxVersion: "be"
cfengine: "adobe@2021"
experimental: true
- coldboxVersion: "be"
cfengine: "adobe@2023"
experimental: true
steps:
- name: Checkout Repository
uses: actions/checkout@v3
uses: actions/checkout@v4


- name: Setup Java
uses: actions/setup-java@v3
uses: actions/setup-java@v4
with:
distribution: "temurin"
java-version: "11"
Expand Down Expand Up @@ -92,7 +95,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: |
Expand All @@ -105,7 +108,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: |
Expand Down
6 changes: 4 additions & 2 deletions .markdownlint.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,7 @@
"no-multiple-blanks": {
"maximum": 2
},
"no-inline-html" : false
}
"no-inline-html" : false,
"no-hard-tabs": false,
"no-bare-urls": false
}
88 changes: 88 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# cbdebugger 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:

- [Code Of Conduct](#code-of-conduct)
- [Bug Reporting](#bug-reporting)
- [Support Questions](#support-questions)
- [Security Vulnerabilities](#security-vulnerabilities)
- [Language Compatibility](#language-compatibility)
- [Coding Styles \& Formatting](#coding-styles--formatting)
- [CFC Docs With DocBox](#cfc-docs-with-docbox)
- [Financial Contributions](#financial-contributions)
- [Contributors](#contributors)

## Code Of Conduct

This project is open source, and as such, the maintainers give their free time to build and maintain the source code held within. They make the code freely available in the hope that it will be of use to other developers and/or businesses. Please be considerate towards maintainers when raising issues or presenting pull requests. **We all follow the Golden Rule: Do to others as you want them to do to you.**

- As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
- Participants will be tolerant of opposing views.
- Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
- Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
- When interpreting the words and actions of others, participants should always assume good intentions. Emotions cannot be derived from textual representations.
- Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.

## Bug Reporting

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/cbdebugger

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.

## Support Questions

If you have any questions on usage, professional support or just ideas to bounce off the maintainers, please do not create an issue. Leverage our support channels first.

- Ortus Community Discourse: https://community.ortussolutions.com/
- Box Slack Team : https://boxteam.ortussolutions.com/
- Professional Support : https://www.ortussolutions.com/services/support

## Security Vulnerabilities

If you discover a security vulnerability, please send an email to the development team at [security@ortussolutions.com](mailto:security@ortussolutions.com?subject=security) and make sure you report it to the `#security` channel in our Box Team Slack Channel. All security vulnerabilities will be promptly addressed.

## Language Compatibility

Please make sure your code runs on the following CFML Engines:

- Lucee 5+
- Adobe ColdFusion 2018+

## Coding Styles & Formatting

We are big on coding styles and have included a `.cfformat.json` in the root of the project so that you can run the formatting tools and CommandBox scripts:

```bash
# Format everything
box run-script format

# Start a watcher, type away, save and auto-format for you
box run-script format: watch
```

We recommend that anytime you hack on the core you start the formatter watcher (`box run-script format:watch`). This will monitor your changes and auto-format your code for you.

You can also see the Ortus Coding Standards you must follow here: https://github.com/Ortus-Solutions/coding-standards.

## CFC Docs With DocBox

All CFCs are self-documenting and we leverage [DocBox](https://docbox.ortusbooks.com/) to document the entire software. All functions must be properly documented using the DocBox syntax: https://docbox.ortusbooks.com/getting-started/annotating-your-code

## Financial Contributions

You can support ColdBox and all of our Open Source initiatives at Ortus Solutions by becoming a patreon. You can also get lots of goodies and services depending on the level of contributions.

- [Become a backer or sponsor on Patreon](https://www.patreon.com/ortussolutions)
- [One-time donations via PayPal](https://www.paypal.com/paypalme/ortussolutions)

## Contributors

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/cbdebugger/graphs/contributors">
<img src = "https://contrib.rocks/image?repo=coldbox-modules/cbdebugger"/>
</a>

Made with [contributors-img](https://contrib.rocks)
Loading

0 comments on commit 32d096b

Please sign in to comment.