newspack-scripts 3.1.0 → 3.1.1

package/.yamllint

@@ -0,0 +1,7 @@
+extends: relaxed
+
+rules:
+    line-length:
+        max: 200
+        allow-non-breakable-inline-mappings: true
+

package/README.md

@@ -86,7 +86,7 @@ The following assumes that CI will run:
 
 This package exposes a couple of configuration files.
 
-### webpack
+### Webpack
 
 The `webpack.config.js` file should use this package's config-extending function:
 
@@ -105,7 +105,7 @@ const webpackConfig = getBaseWebpackConfig(
 module.exports = webpackConfig;
 ```
 
-### babel
+### Babel
 
 A basic `babel.config.js`:
 
@@ -141,6 +141,38 @@ stylelint '**/*.scss' --syntax scss --config=./node_modules/newspack-scripts/con
 
 _Note: Due to issue with dependency resolving, you might end up a different version of `prettier` in project's `node_modules` and `node_modules/newspack-scripts/node_modules`. See https://github.com/Automattic/newspack-scripts/issues/1 for more information._
 
+### TypeScript
+
+See note about `typescript-check` script above.
+
+---
+
+## CircleCI Orb
+
+This repository hosts a [CircleCI Orb](https://circleci.com/docs/2.0/orb-intro), in `/src` directory. An Orb is a re-usable configuration – here's an example of how to use it:
+
+```yml
+version: 2.1
+
+orbs:
+  newspack: adekbadek/newspack@1.0.0
+
+workflows:
+  version: 2
+  all:
+    jobs:
+      - newspack/build
+```
+
+### Updating the Orb
+
+To update the Orb, use [CircleCI's CLI's](https://circleci.com/docs/2.0/local-cli/) [`pack`](https://circleci-public.github.io/circleci-cli/circleci_orb_pack.html) and [`publish`](https://circleci-public.github.io/circleci-cli/circleci_orb_publish.html) commands:
+
+```bash
+# Replace the `version` at the end (e.g. 1.0.1)
+circleci orb pack src/ > orb.yml && circleci orb publish orb.yml adekbadek/newspack@version
+```
+
 ---
 
 ## Misc

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newspack-scripts",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "description": "",
   "bin": {
     "newspack-scripts": "./bin/newspack-scripts.js"

package/post-release.sh

@@ -35,7 +35,6 @@ fi
 echo '[newspack-scripts] Merging the release branch into master'
 git checkout master
 # Merge release branch into master branch, prefering the changes from release branch if conflicts arise.
-git merge --squash release --strategy-option=theirs
-git commit --message "chore(release): merge in release $LATEST_VERSION_TAG"
+git merge --no-ff release --strategy-option=theirs -m "chore(release): merge in release $LATEST_VERSION_TAG"
 # Push updated master upstream.
 git push "https://$GITHUB_TOKEN@github.com/$CIRCLE_PROJECT_USERNAME/$CIRCLE_PROJECT_REPONAME.git"

package/src/@orb.yml

@@ -0,0 +1,8 @@
+version: 2.1
+
+description: >
+  Newspack shared CI config.
+
+display:
+  home_url: "https://newspack.pub"
+  source_url: "https://www.github.com/Automattic/newspack-scripts"

package/src/commands/checkout_with_workspace.yml

@@ -0,0 +1,6 @@
+description: >
+  Chechout code and attach workspace.
+steps:
+  - checkout
+  - attach_workspace:
+      at: ~/

package/src/executors/default.yml

@@ -0,0 +1,11 @@
+description: >
+  This is a sample executor using Docker and Node.
+docker:
+  - image: 'cimg/php:<<parameters.tag>>'
+parameters:
+  tag:
+    default: 7.4-browsers
+    description: >
+      Pick a specific circleci/php image variant:
+      https://hub.docker.com/r/cimg/php/tags
+    type: string

package/src/jobs/build-distributable.yml

@@ -0,0 +1,24 @@
+description: >
+  Build the distributable files, so they are available as CI artifacts.
+
+executor: default
+
+parameters:
+  archive-name:
+    type: string
+    default: ""
+    description: "Name of the ZIP archive distributable."
+
+steps:
+  - checkout_with_workspace
+  - run:
+      name: Install rsync
+      command: sudo apt-get update && sudo apt-get install rsync
+  - run:
+      name: Install PHP packages
+      command: composer install --no-dev --no-scripts
+  - run:
+      name: Build plugin files
+      command: npm run build && npm run release:archive
+  - store_artifacts:
+      path: release/<<parameters.archive-name>>.zip

package/src/jobs/build.yml

@@ -0,0 +1,21 @@
+description: >
+  Install node dependencies.
+
+executor: default
+
+steps:
+  - checkout_with_workspace
+  - restore_cache:
+      key: v1-npm-{{ checksum "package.json" }}-{{checksum "package-lock.json" }}
+  # https://medium.com/@mdsky1986/caching-node-dependencies-when-using-npm-ci-89fe3f46404a
+  - run:
+      name: Install node dependencies
+      command: "[ ! -d node_modules ] && npm ci --loglevel warn --yes || echo package.json and package-lock.json unchanged. Using cache."
+  - save_cache:
+      key: v1-npm-{{ checksum "package.json" }}-{{checksum "package-lock.json" }}
+      paths:
+        - node_modules
+  - persist_to_workspace:
+      root: ~/
+      paths:
+        - project

package/src/jobs/lint-js-scss.yml

@@ -0,0 +1,10 @@
+description: >
+  Lint the JS & SCSS files.
+
+executor: default
+
+steps:
+  - checkout_with_workspace
+  - run:
+      name: Run Linter
+      command: npm run lint

package/src/jobs/lint-php.yml

@@ -0,0 +1,12 @@
+description: >
+  Lint PHP files.
+
+executor: default
+
+steps:
+  - checkout
+  - run:
+      name: Lint Files
+      command: |
+        composer install
+        ./vendor/bin/phpcs

package/src/jobs/post-release.yml

@@ -0,0 +1,10 @@
+description: >
+  Perform post-release tasks.
+
+executor: default
+
+steps:
+  - checkout_with_workspace
+  - run:
+      name: Perform post-release chores
+      command: ./node_modules/newspack-scripts/post-release.sh

package/src/jobs/release.yml

@@ -0,0 +1,20 @@
+description: >
+  Release new version.
+
+executor: default
+
+steps:
+  - checkout_with_workspace
+  - run:
+      name: Install rsync
+      command: sudo apt-get update && sudo apt-get install rsync
+  - run:
+      name: Install PHP packages
+      command: composer install --no-dev --no-scripts
+  - run:
+      name: Release new version
+      command: npm run release
+  - persist_to_workspace:
+      root: ~/
+      paths:
+        - project

package/src/jobs/test-js.yml

@@ -0,0 +1,10 @@
+description: >
+  Run JS tests.
+
+executor: default
+
+steps:
+  - checkout_with_workspace
+  - run:
+      name: Run JS Tests
+      command: npm run test

package/src/jobs/test-php.yml

@@ -0,0 +1,29 @@
+description: >
+  Run PHP tests.
+
+docker:
+  - image: cimg/php:7.4
+  - image: circleci/mysql:5.6.50
+
+environment:
+  - WP_TESTS_DIR: '/tmp/wordpress-tests-lib'
+  - WP_CORE_DIR: '/tmp/wordpress/'
+steps:
+  - checkout
+  - run:
+      name: Setup Environment Variables
+      command: |
+        echo "export PATH=$HOME/.composer/vendor/bin:$PATH" >> $BASH_ENV
+        source /home/circleci/.bashrc
+  - run:
+      name: Install Dependencies
+      command: |
+        sudo apt-get update && sudo apt-get install -y subversion default-mysql-client
+  - run:
+      name: Run Tests
+      command: |
+        composer install
+        composer global require "phpunit/phpunit=7.5.*"
+        rm -rf $WP_TESTS_DIR $WP_CORE_DIR
+        bash bin/install-wp-tests.sh wordpress_test root '' 127.0.0.1 5.8.1
+        phpunit