newspack-scripts 5.3.0 → 5.5.0

package/README.md

@@ -196,6 +196,11 @@ circleci orb pack src/ > orb.yml && circleci orb publish orb.yml newspack/newspa
 
 Note that before the first time updating you'll need to set the API key for CircleCI CLI by running `$ circleci setup`.
 
+### Testing locally
+
+1. Copy the path to this repository (e.g. `pwd | pbcopy`) and "install" it as an npm dependency in the repository on which you wish to test (e.g. `npm i /path/to/newspack-scripts`). You should end up with a `"newspack-scripts": "file:*"` entry in `package.json` instead of a version number.
+2. Trigger a script and observe the results, e.g. `npm run semantic-release -- --dry-run`
+
 ---
 
 ## Misc

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newspack-scripts",
-  "version": "5.3.0",
+  "version": "5.5.0",
   "description": "",
   "bin": {
     "newspack-scripts": "./bin/newspack-scripts.js"
@@ -65,6 +65,15 @@
   "scripts": {
     "semantic-release": "semantic-release"
   },
+  "release": {
+    "branches": [
+      "trunk",
+      {
+        "name": "alpha",
+        "prerelease": true
+      }
+    ]
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/Automattic/newspack-scripts.git"

package/scripts/release.js

@@ -21,6 +21,8 @@ if (shouldPublishOnNPM) {
 }
 
 const getConfig = ({ gitBranchName }) => {
+  const branchType = gitBranchName.split("/")[0];
+
   const config = {
     dryRun: otherArgs.dryRun,
     ci: otherArgs.ci,
@@ -71,6 +73,8 @@ const getConfig = ({ gitBranchName }) => {
               label: `${process.env.CIRCLE_PROJECT_REPONAME}.zip`,
             },
           ],
+          // Only post GH PR comments for alpha, hotfix/*, and release branches.
+          successComment: ["alpha", "hotfix", "release"].includes(branchType),
         },
       ],
     ],
@@ -87,24 +91,31 @@ const getConfig = ({ gitBranchName }) => {
   ]);
 
   // Unless on a hotfix or epic branch, add a commit that updates the files.
-  if (gitBranchName.indexOf("hotfix/") !== 0 && gitBranchName.indexOf("epic/") !== 0) {
-    utils.log(`Plugin files and the changelog will be updated.`);
-    config.prepare.push({
-      path: "@semantic-release/git",
-      // These assets should be added to source control after a release.
-      assets: [
+  if (["hotfix", "epic"].indexOf(branchType) === -1) {
+    let assets = filesList;
+    // These assets should be added to source control after a release.
+    if (branchType === "release") {
+      assets = [
         ...filesList,
         "package.json",
         "package-lock.json",
         "CHANGELOG.md",
-      ],
+      ];
+    }
+    utils.log(
+      `On ${branchType} branch, following files will be updated: ${assets.join(
+        ", "
+      )}`
+    );
+    config.prepare.push({
+      path: "@semantic-release/git",
+      assets,
       message:
         "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}",
     });
   } else {
-    const branchType = gitBranchName.indexOf("hotfix/") === 0 ? 'hotfix' : 'epic';
     utils.log(
-      `This is a ${branchType} branch, plugin files and the changelog will *not* be updated.`
+      `This branch is ${branchType}, plugin files and the changelog will *not* be updated.`
     );
   }
 

package/src/jobs/test-php.yml

@@ -20,9 +20,30 @@ steps:
       command: |
         sudo apt-get update && sudo apt-get install -y subversion default-mysql-client
   - run:
-      name: Run Tests
+      name: Run Tests with Coverage
       command: |
         composer update
         rm -rf $WP_TESTS_DIR $WP_CORE_DIR
         bash bin/install-wp-tests.sh wordpress_test root '' 127.0.0.1 latest
-        ./vendor/bin/phpunit
+        # https://circleci.com/docs/code-coverage/#php
+        XDEBUG_MODE=coverage phpdbg -qrr vendor/bin/phpunit --coverage-clover coverage.xml
+  - run:
+      name: Upload Test Results to Codecov
+      command: |
+        if [[ -n $CODECOV_TOKEN ]]; then
+          # download Codecov CLI
+          curl -Os https://cli.codecov.io/latest/linux/codecov
+
+          # integrity check
+          curl https://keybase.io/codecovsecurity/pgp_keys.asc | gpg --no-default-keyring --keyring trustedkeys.gpg --import # One-time step
+          curl -Os https://cli.codecov.io/latest/linux/codecov
+          curl -Os https://cli.codecov.io/latest/linux/codecov.SHA256SUM
+          curl -Os https://cli.codecov.io/latest/linux/codecov.SHA256SUM.sig
+          gpgv codecov.SHA256SUM.sig codecov.SHA256SUM
+
+          shasum -a 256 -c codecov.SHA256SUM
+          sudo chmod +x codecov
+          ./codecov upload-process -t $CODECOV_TOKEN
+        else
+          echo "CODECOV_TOKEN is not set. Skipping upload to Codecov."
+        fi