From 5c047f1ee301a8c25308651bb21b9363f20f4aec Mon Sep 17 00:00:00 2001 From: Luis Majano Date: Thu, 20 Apr 2023 15:00:28 +0200 Subject: [PATCH] more syntax updates and tests --- .github/workflows/release.yml | 28 ++++++++- CONTRIBUTING.md | 8 +-- changelog.md | 108 +++++++++++++++++----------------- readme.md | 17 +++++- 4 files changed, 101 insertions(+), 60 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index b947734..48e0e7c 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -58,6 +58,8 @@ jobs: - 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 }} @@ -87,9 +89,33 @@ jobs: .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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9e0f1be..b67430f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# CBSecurity Contributing Guide +# cbstorages 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/cbstorages 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! - - + + Made with [contributors-img](https://contrib.rocks) diff --git a/changelog.md b/changelog.md index 227dd37..e252c13 100644 --- a/changelog.md +++ b/changelog.md @@ -19,122 +19,122 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed -* Cookie is being set twice. Appears twice in response headers, one of them does not have the attributes (only the value) +- Cookie is being set twice. Appears twice in response headers, one of them does not have the attributes (only the value) ## [3.0.0] => 2022-OCT-4 ### Added -* New ortus module support +- New ortus module support ### Changed -* Removed ACF 2016 support +- Removed ACF 2016 support ## [2.6.1] => 2021-JUL-23 ### Fixed -* Added params to the cache storage settings to avoid missing setting exceptions +- Added params to the cache storage settings to avoid missing setting exceptions -## [2.6.0]] => 2021-JUL-22 +## [2.6.0] => 2021-JUL-22 ### Added -* New setting for `cacheStorage` : `identifierProvider` which can be a closure/lambda/udf that returns a unique tracking identifier for user requests. -* Improved session detection and fallback to request tracking if no session/cookie/url tracking is discovered thanks to @elpete : https://github.com/coldbox-modules/cbstorages/pull/15/files -* Migration to github actions for CI process -* Adobe 2021 automated support +- New setting for `cacheStorage` : `identifierProvider` which can be a closure/lambda/udf that returns a unique tracking identifier for user requests. +- Improved session detection and fallback to request tracking if no session/cookie/url tracking is discovered thanks to @elpete : https://github.com/coldbox-modules/cbstorages/pull/15/files +- Migration to github actions for CI process +- Adobe 2021 automated support -## [2.5.0]] => 2021-APR-01 +## [2.5.0] => 2021-APR-01 -* Added `sameSite` argument to setting cookies +- Added `sameSite` argument to setting cookies -## [2.4.0]] => 2020-NOV-30 +## [2.4.0] => 2020-NOV-30 ### Added -* Set `expires` is not defaulted to 0 which eliminates the cookie. It is now expiring as it should using the browser session as the key indicator. +- Set `expires` is not defaulted to 0 which eliminates the cookie. It is now expiring as it should using the browser session as the key indicator. ## [2.3.0] => 2020-NOV-13 ### Added -* Changelog publishing -* Refactored lock timeouts to be part of the `AbstractStorage` thanks to @wpdebruin +- Changelog publishing +- Refactored lock timeouts to be part of the `AbstractStorage` thanks to @wpdebruin ### Fixed -* Invalid argument when using `getOrSet` thanks to @wpdebruin -* Apply cookies in reverse order so the one with all the attributes is last and is persisted by Eric Peterson +- Invalid argument when using `getOrSet` thanks to @wpdebruin +- Apply cookies in reverse order so the one with all the attributes is last and is persisted by Eric Peterson ## [2.2.0] => 2020-JUL-09 ### Added -* New module layouts and helpers -* Github auto release notes publishing -* More formatting goodness -* New Changelogs -* [BOX-77] Add CGI scope wrapper to cbStorages +- New module layouts and helpers +- Github auto release notes publishing +- More formatting goodness +- New Changelogs +- [BOX-77] Add CGI scope wrapper to cbStorages ## [2.1.0] => 2020-FEB-03 -* `improvement` : Remove `numeric` typing on `expiry` for CookieStorage: The numeric typing on the expires argument will still allow a date object to pass through ( strangely ), but prevents the pass through of the textual arguments allowed by CFCookie: https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-tags/tags-c/cfcookie.html -* `improvement` : Added formatting and linting scripts -* `bug` : Fixed `toMaster` script so it could pull master incase of divergence +- `improvement` : Remove `numeric` typing on `expiry` for CookieStorage: The numeric typing on the expires argument will still allow a date object to pass through ( strangely ), but prevents the pass through of the textual arguments allowed by CFCookie: https://helpx.adobe.com/coldfusion/cfml-reference/coldfusion-tags/tags-c/cfcookie.html +- `improvement` : Added formatting and linting scripts +- `bug` : Fixed `toMaster` script so it could pull master incase of divergence ## [2.0.1] -* `bug` : [CCM-54](https://ortussolutions.atlassian.net/browse/CCM-54) - Left over bug on session storage looking at app storage +- `bug` : [CCM-54](https://ortussolutions.atlassian.net/browse/CCM-54) - Left over bug on session storage looking at app storage ## [2.0.0] -* `feature` : All storages now implement a common interface : `IStorage` -* `feature` : New interface brings new storageWide methods: `setMulti(), getOrSet(), getMulti(), deleteMulti(), getSize(), getkeys(), isEmpty()` -* `feature,compat` : ColdBox 4/5 approach to settings instead of in the root, in the `moduleSettings` -* `improvement,compat` : All tag based default values where named `default` but renamed to `defaultValue` to have consistency. -* `improvement` : Dropped Lucee4.5 and ACF11 support -* `improvement` : Script migrations -* `feature` : Added support for httpOnly and secure cookies in the cookie storage. -* `improvement` : Added option to specify path when deleting a cookie. Without this option, the cookie is never deleted when specifying a path when creating a cookie. https://github.com/coldbox-modules/cbstorages/pull/7 (@donbellamy) -* `improvement` : TestBox 3 upgrade -* `improvement` : Mark all storages as `serializable=false` to avoid serialization issues -* `compat` : Removed `ClusterStorage` as this was a lucee only feature that actually never released. -* `compat` : The following methods have been renamed: `setVar() => set()`, `getVar() => get()`, and `deleteVar() => delete()` +- `feature` : All storages now implement a common interface : `IStorage` +- `feature` : New interface brings new storageWide methods: `setMulti(), getOrSet(), getMulti(), deleteMulti(), getSize(), getkeys(), isEmpty()` +- `feature,compat` : ColdBox 4/5 approach to settings instead of in the root, in the `moduleSettings` +- `improvement,compat` : All tag based default values where named `default` but renamed to `defaultValue` to have consistency. +- `improvement` : Dropped Lucee4.5 and ACF11 support +- `improvement` : Script migrations +- `feature` : Added support for httpOnly and secure cookies in the cookie storage. +- `improvement` : Added option to specify path when deleting a cookie. Without this option, the cookie is never deleted when specifying a path when creating a cookie. https://github.com/coldbox-modules/cbstorages/pull/7 (@donbellamy) +- `improvement` : TestBox 3 upgrade +- `improvement` : Mark all storages as `serializable=false` to avoid serialization issues +- `compat` : Removed `ClusterStorage` as this was a lucee only feature that actually never released. +- `compat` : The following methods have been renamed: `setVar() => set()`, `getVar() => get()`, and `deleteVar() => delete()` ## [1.5.0] -* Update new template approach -* Renamed repo -* Change `getSessionKey` to public method: https://github.com/coldbox-modules/cbox-storages/pull/6 +- Update new template approach +- Renamed repo +- Change `getSessionKey` to public method: https://github.com/coldbox-modules/cbox-storages/pull/6 ## [1.4.0] -* Updated to leverage workbench module template -* Remove useless entry points thanks to @tropicalista -* Make default cache for `CacheStorage` to be the `template` cache instead of `default` +- Updated to leverage workbench module template +- Remove useless entry points thanks to @tropicalista +- Make default cache for `CacheStorage` to be the `template` cache instead of `default` ## [1.3.0] -* Updated API docs with a syntax typo -* New `RequestStorage` thanks to Dan Murphy -* Updated travis process for self-publishing +- Updated API docs with a syntax typo +- New `RequestStorage` thanks to Dan Murphy +- Updated travis process for self-publishing ## [1.2.0] -* Update build process -* Updated dependencies -* Added new storage: `CacheStorage` to allow you to simulate session/client on a distributed cache via CacheBox. +- Update build process +- Updated dependencies +- Added new storage: `CacheStorage` to allow you to simulate session/client on a distributed cache via CacheBox. ## [1.1.0] -* Travis integration -* DocBox updates -* Build process updates +- Travis integration +- DocBox updates +- Build process updates ## [1.0.0] -* Create first module version +- Create first module version diff --git a/readme.md b/readme.md index 68be408..cf991d4 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,19 @@ -[![cbstorages CI](https://github.com/coldbox-modules/cbstorages/actions/workflows/ci.yml/badge.svg)](https://github.com/coldbox-modules/cbstorages/actions/workflows/ci.yml) +

+ +
+ + + +

+ +

+ Copyright Since 2005 ColdBox Platform by Luis Majano and Ortus Solutions, Corp +
+ www.coldbox.org | + www.ortussolutions.com +

+ +---- # Welcome to the cbStorages Module