From acb067fdc23e2116357fb6f5dd4ee9ade5801765 Mon Sep 17 00:00:00 2001 From: Steve Boyd Date: Thu, 23 Mar 2023 14:15:48 +1300 Subject: [PATCH 1/2] MNT Use gha-dispatch-ci (#32) --- .github/workflows/ci.yml | 5 ----- .github/workflows/dispatch-ci.yml | 16 ++++++++++++++++ 2 files changed, 16 insertions(+), 5 deletions(-) create mode 100644 .github/workflows/dispatch-ci.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2878ad7..bf02210 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -4,13 +4,8 @@ on: push: pull_request: workflow_dispatch: - # Every Friday at 12:00pm UTC - schedule: - - cron: '0 12 * * 5' jobs: ci: name: CI - # Only run cron on the silverstripe account - if: (github.event_name == 'schedule' && github.repository_owner == 'silverstripe') || (github.event_name != 'schedule') uses: silverstripe/gha-ci/.github/workflows/ci.yml@v1 diff --git a/.github/workflows/dispatch-ci.yml b/.github/workflows/dispatch-ci.yml new file mode 100644 index 0000000..c334bb0 --- /dev/null +++ b/.github/workflows/dispatch-ci.yml @@ -0,0 +1,16 @@ +name: Dispatch CI + +on: + # At 12:00 PM UTC, only on Friday and Saturday + schedule: + - cron: '0 12 * * 5,6' + +jobs: + dispatch-ci: + name: Dispatch CI + # Only run cron on the silverstripe account + if: (github.event_name == 'schedule' && github.repository_owner == 'silverstripe') || (github.event_name != 'schedule') + runs-on: ubuntu-latest + steps: + - name: Dispatch CI + uses: silverstripe/gha-dispatch-ci@v1 From 190bf80dbefde6d2d344c8fedcfa34fabb9eb9c7 Mon Sep 17 00:00:00 2001 From: Guy Sartorelli Date: Wed, 19 Apr 2023 16:24:39 +1200 Subject: [PATCH 2/2] DOC Update README.md for CMS 5 --- README.md | 48 +++++++++++++++++++++++++++--------------------- 1 file changed, 27 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 9db17a0..1040e87 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,12 @@ These recipes allow for the following features: recipe dependencies without mandating the inclusion of all requirements directly. - An `update-recipe` command to upgrade to a newer version of a recipe. +## Installation + +```sh +composer require silverstripe/recipe-plugin +``` + ## Example output ![example-output](docs/_images/require-usage.png) @@ -27,15 +33,15 @@ These recipes allow for the following features: Recipes can be introduced to any existing project (even if not created on a silverstripe base project) -```shell -$ composer init -$ composer require silverstripe/recipe-cms ^1.0@dev -```` +```sh +composer init +composer require silverstripe/recipe-cms +``` Alternatively you can create a new project based on an existing recipe -```shell -$ composer create-project silverstripe/recipe-cms ./myssproject ^1.0@dev +```sh +composer create-project silverstripe/recipe-cms ./myssproject ``` ## Inlining recipes @@ -50,18 +56,18 @@ install a new recipe. Note that if you wish to run this command you must first install either a recipe via normal composer commands, or install the recipe plugin: -```shell -$ composer init -$ composer require silverstripe/recipe-plugin ^0.1 -$ composer require-recipe silverstripe/recipe-cms ^1.0@dev +```sh +composer init +composer require silverstripe/recipe-plugin +composer require-recipe silverstripe/recipe-cms ``` or -```shell -$ composer init -$ composer require silverstripe/recipe-cms ^1.0@dev -$ composer update-recipe silverstripe/recipe-cms +```sh +composer init +composer require silverstripe/recipe-cms +composer update-recipe silverstripe/recipe-cms ``` ## Removing recipe dependencies or files @@ -80,9 +86,9 @@ as below. "mysite/code/PageController.php" ], "project-dependencies-installed": { - "silverstripe/admin": "1.0.x-dev", - "silverstripe/asset-admin": "1.0.x-dev", - "silverstripe/campaign-admin": "1.0.x-dev" + "silverstripe/admin": "2.0.x-dev", + "silverstripe/asset-admin": "2.0.x-dev", + "silverstripe/campaign-admin": "2.0.x-dev" } } } @@ -148,10 +154,10 @@ An example recipe: "description": "Example silverstripe recipe", "type": "silverstripe-recipe", "require": { - "silverstripe/recipe-plugin": "^0.1", - "silverstripe/recipe-cms": "^1.0", - "silverstripe/blog": "^3.0@dev", - "silverstripe/lumberjack": "^2.1@dev", + "silverstripe/recipe-plugin": "^1.0", + "silverstripe/recipe-cms": "^5.0", + "silverstripe/blog": "^4.0", + "silverstripe/lumberjack": "^3.0", }, "extra": { "project-files": [