Introduce npmCheckDay parameter to update-deps workflow

.nvmrc

@@ -1 +1 @@
-v14.16.1
+v14

README.md

@@ -99,9 +99,13 @@ Since this workflow uses labels to mark stale issues/PRs, labels should be alrea
 * `resolution:expired` - label added to stale issues which got closed due to inactivity.
 * `pr:frozen ❄` - label added to stale PRs which got closed due to inactivity.
 
-### update-deps
+### update-deps-semversion
 
-Workflow responsible for updating NPM dependencies. It is run on 1st and 15th day of each month (at 05:00 UTC) and creates two PRs - one for dev dependencies and one for production ones (if there are any outdated dependencies). It checks `package.json` file in the repository root and uses `npm-check` to update all dev/prod dependencies (which means `package.json` versioning is not respected). It is a cron job task so will be triggered only on main repository branch. See `workflows/update-deps.yml` file.
+Workflow responsible for updating NPM dependencies. It is run on 1st and 15th day of each month (at 05:00 UTC) and creates two PRs - one for dev dependencies and one for production ones (if there are any outdated dependencies). It checks `package.json` file in the repository root. Depends on provided config, it will use `npm-check` (`semversion` compatibility mode) or `npm_update` (bump version to newest available) to update all dev/prod dependencies. It is a cron job task so will be triggered only on main repository branch. See `workflows/update-deps-semversion.yml` file.
+
+### update-deps-to-newest
+
+Workflow responsible for running `update-deps-semversion` workflow, but with config that disables semversion compatibility. It is scheduled to run once a month. See `workflows/update-deps-to-newest.yml` file.
 
 #### Required secrets
 
@@ -116,18 +120,31 @@ Workflow responsible for updating NPM dependencies. It is run on 1st and 15th da
 
 ### Running tests
 
-To run tests, create `.env` file with the following variables:
+To run tests, in the `ckeditor4-workflows-common` repo create an `.env` file with the following variables:
 
-* `AUTH_KEY` - GitHub key with permissions to commit files, read and run workflows / actions.
+* `AUTH_KEY` - GitHub key with permissions to commit files, read and run workflows / actions. To get a token follow [Creating a personal access token](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) tutorial.
 * `OWNER` - Owner of tests repo, e.g. `ckeditor`.
-* `REPO` - Tests repo name, e.g. `workflow-tests`. It should be an empty repository with `master` branch and `README.md` file only.
+* `REPO` - Tests repo name, e.g. `workflow-tests`. It should be an empty repository with `master` branch and `README.md` file only. Remember it also requires setting your GH Secrets on repo level (the ones inherited from organization level probably won't work). For now to run all workflows you need 3 secrets:
+  * `GH_WORKFLOWS_TOKEN` (same as `AUTH_KEY` variable);
+  * `GH_BOT_EMAIL` (most likely you );
+  * `GH_BOT_USERNAME`.
 
-Then run:
+So the file should look like this:
+
+```
+AUTH_KEY="ghp_heregoesquitealonghash"
+OWNER="ckeditor"
+REPO="workflow-tests-PR-100"
+```
+
+Then (still being in `ckeditor4-workflows-common` repo) run:
 
 ```
 npm test
 ```
 
+Remember to use appropriate Node.js version (v14). After tests are finished, you need to manually check in testing repo if everything was done as it should be (tests only check if workflows were executed).
+
 ### Adding tests
 
 Tests case for new workflows should be added in `tests/fixtures` directory - for example `new-workflow.yml` should be covered with tests from `tests/fixtures/new-workflow.js`. The test file should export array of tests cases (see example below).

package.json

@@ -18,7 +18,7 @@
   "homepage": "https://github.com/ckeditor/ckeditor4-workflows-common#readme",
   "dependencies": {
     "@octokit/request": "^5.4.14",
-    "dotenv": "^8.2.0",
-    "chalk": "^4.1.0"
+    "chalk": "^4.1.1",
+    "dotenv": "^8.2.0"
   }
 }

tests/assets/deps-package-outdated-fixed-version.json

@@ -0,0 +1,18 @@
+{
+  "name": "fixtures",
+  "version": "1.0.0",
+  "description": "",
+  "main": "setup-workflows.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "core-js": "2.0.0",
+    "eslint": "5.0.0"
+  },
+  "dependencies": {
+    "chalk": "3.0.0"
+  }
+}

tests/assets/deps-package-up-to-date.json

@@ -0,0 +1,18 @@
+{
+  "name": "fixtures",
+  "version": "1.0.0",
+  "description": "",
+  "main": "setup-workflows.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "core-js": "^2.6.12",
+    "eslint": "^7.27.0"
+  },
+  "dependencies": {
+    "chalk": "^4.1.1"
+  }
+}

tests/config.js

@@ -1,4 +1,5 @@
 const dotenv = require( 'dotenv' );
+const chalk = require( 'chalk' );
 
 function config() {
 	dotenv.config();

tests/fixtures/setup-workflows.js

@@ -3,9 +3,7 @@ module.exports = [ {
 		workflow: 'setup-workflows.yml',
 		branch: 'master',
 		config: {
-			'setupWorkflows': {
-				'pushAsPullRequest': 'false'
-			}
+			'pushAsPullRequest': 'false'
 		}
 	}, {
 		name: 'setup-workflows direct push (no config)',
@@ -16,9 +14,7 @@ module.exports = [ {
 		workflow: 'setup-workflows.yml',
 		branch: 'master',
 		config: {
-			'setupWorkflows': {
-				'pushAsPullRequest': 'true'
-			}
+			'pushAsPullRequest': 'true'
 		}
 	}
 ];

tests/fixtures/update-deps-semversion.js

@@ -0,0 +1,58 @@
+let date = new Date();
+let testNpmCheck = true;
+let npmCheckDay = testNpmCheck ? date.getDate() : date.getDate() + 1;
+
+module.exports = [
+	{
+		name: 'update-deps branch without package.json file',
+		workflow: 'update-deps-semversion.yml',
+		branch: 'master',
+		config: {
+			'targetBranch': 'master'
+		}
+	}, {
+		name: 'update-deps on up-to-date branch',
+		workflow: 'update-deps-semversion.yml',
+		branch: 'master',
+		config: {
+			'targetBranch': 'master'
+		},
+		fileList: [ {
+			src: 'deps-package-up-to-date.json',
+			dest: 'package.json'
+		} ]
+	}, {
+		name: 'update-deps PR',
+		workflow: 'update-deps-semversion.yml',
+		branch: 'master',
+		config: {
+			'targetBranch': 'master'
+		},
+		fileList: [ {
+			src: 'deps-package-outdated.json',
+			dest: 'package.json'
+		} ]
+	}, {
+		name: 'update-deps with npm-check on custom day of month',
+		workflow: 'update-deps-semversion.yml',
+		branch: 'master',
+		config: {
+			'npmCheckDay': npmCheckDay
+		},
+		fileList: [ {
+			src: 'deps-package-outdated.json',
+			dest: 'package.json'
+		} ]
+	}, {
+		name: 'update-deps on non-existing branch',
+		workflow: 'update-deps-semversion.yml',
+		branch: 'master',
+		config: {
+			'targetBranch': 'main'
+		},
+		fileList: [ {
+			src: 'deps-package-outdated.json',
+			dest: 'package.json'
+		} ]
+	}
+];

tests/fixtures/update-deps-to-newest.js

@@ -0,0 +1,37 @@
+module.exports = [
+	{
+		name: 'update-deps with empty init cfg',
+		workflow: 'update-deps-to-newest.yml',
+		branch: 'master',
+		config: {},
+		fileList: [ {
+			src: 'deps-package-outdated-fixed-version.json',
+			dest: 'package.json'
+		} ]
+	},
+	{
+		name: 'update-deps with targetBranch in cfg',
+		workflow: 'update-deps-to-newest.yml',
+		branch: 'master',
+		config: {
+			targetBranch: 'master'
+		},
+		fileList: [ {
+			src: 'deps-package-outdated-fixed-version.json',
+			dest: 'package.json'
+		} ]
+	},
+	{
+		name: 'update-deps with bump on false in cfg',
+		workflow: 'update-deps-to-newest.yml',
+		branch: 'master',
+		config: {
+			targetBranch: 'master',
+			bump: 'false'
+		},
+		fileList: [ {
+			src: 'deps-package-outdated-fixed-version.json',
+			dest: 'package.json'
+		} ]
+	}
+];

tests/helpers/test-runner.js

@@ -71,7 +71,7 @@ async function runTest( testCase ) {
 		console.log( `Status: ${ chalk.yellow( workflowObject.status ) }. Result: ${ chalk.yellow( workflowObject.conclusion ) }. Next check in ${ waitingTime }ms` );
 	} );
 
-	console.log( chalk.green( result.name + 'run is finished!' ) + ' Result: ' + chalk.yellow( result.conclusion ) );
+	console.log( chalk.green( '"' + result.name + '" run is finished!' ) + ' Result: ' + chalk.yellow( result.conclusion ) );
 	console.log( `Details: https://github.com/${ process.env.OWNER }/${ process.env.REPO }/actions/runs/${ workflow.id }` );
 }
 

workflows/update-deps.yml → workflows/update-deps-semversion.yml

@@ -1,4 +1,4 @@
-name: Update NPM dependencies
+name: Update NPM dependencies(semversion)
 
 on:
   schedule:
@@ -59,20 +59,39 @@ jobs:
           fi
           echo "BRANCH_TARGET=$BRANCH_TARGET" >> $GITHUB_ENV
 
+          SHOULD_BUMP=$(echo '${{ env.CONFIG }}' | jq -r ".bump")
+          if [[ "$SHOULD_BUMP" == "true" ]]; then
+            echo "DEPS_BUMP_METHOD=npm-check" >> $GITHUB_ENV
+          else
+            echo "DEPS_BUMP_METHOD=npm_update" >> $GITHUB_ENV
+          fi
+
       - name: Check if update branch already exists
         run: |
-          echo "BRANCH_UPDATE=deps-update_${{ env.BRANCH_TARGET }}_${{ matrix.deps }}" >> $GITHUB_ENV
+          echo "BRANCH_UPDATE=deps-${{ env.DEPS_BUMP_METHOD}}_${{ env.BRANCH_TARGET }}_${{ matrix.deps }}" >> $GITHUB_ENV
           if [[ $(git ls-remote --heads | grep deps-update_${{ env.BRANCH_TARGET }}_${{ matrix.deps }} | wc -c) -ne 0 ]]; then
             echo "BRANCH_UPDATE=0" >> $GITHUB_ENV
           fi
 
       - name: Update NPM dependencies
         if: env.BRANCH_UPDATE != 0
         run: |
-          npm i
-          npm install -g npm-check
-          git checkout -b ${{ env.BRANCH_UPDATE }}
-          npm-check -y --${{ matrix.deps }}
+          if [[ ! -f "./package.json" ]]; then
+            echo "'package.json' file not found, with nothing to update the workflow ends here."
+            exit 0
+          fi
+
+          if [[ "${{ env.DEPS_BUMP_METHOD }}" == "npm_update" ]]; then
+            echo "Just npm update today!"
+            git checkout -b ${{ env.BRANCH_UPDATE }}
+            npm update
+          else
+            echo "Running npm-check!"
+            npm i
+            npm install -g npm-check
+            git checkout -b ${{ env.BRANCH_UPDATE }}
+            npm-check -y --${{ matrix.deps }}
+          fi
 
       - name: Add changes
         if: env.BRANCH_UPDATE != 0

workflows/update-deps-to-newest.yml

@@ -0,0 +1,40 @@
+name: Update NPM dependencies(to newest)
+on:
+  schedule:
+    - cron: "0 0 1 * *"
+  workflow_dispatch:
+    inputs:
+      config:
+        description: 'Config'
+        required: false
+        default: ''
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Read config
+        run: |
+          CONFIG='{}'
+          if [[ ! -z '${{ github.event.inputs.config }}' ]]; then
+            CONFIG='${{ github.event.inputs.config }}'
+          elif [[ -f "./.github/workflows-config.json" ]]; then
+            CONFIG=$( jq -c .updateDeps './.github/workflows-config.json' )
+          fi
+          echo "Workflow config: $CONFIG"
+          echo "CONFIG=$CONFIG" >> $GITHUB_ENV
+      - name: Merge configs
+        run: |
+          CONFIG=$(echo '${{ env.CONFIG }}' | jq -c '. += {"bump": "true"}')
+          # echo "${CONFIG}"
+          INPUT_1='{ "config": "'
+          INPUT_2=$(echo "${CONFIG//\"/\\\"}")
+          INPUT_3='"}'
+          INPUT_ALL="${INPUT_1} ${INPUT_2} ${INPUT_3}"
+          echo "INPUT_ALL=$INPUT_ALL" >> $GITHUB_ENV
+      - name: Invoke workflow with inputs
+        uses: benc-uk/workflow-dispatch@v1
+        with:
+          workflow: Update NPM dependencies(semversion)
+          token: ${{ secrets.GH_WORKFLOWS_TOKEN }}
+          inputs: ${{ env.INPUT_ALL }}