newspack-scripts 5.2.0-alpha.1 → 5.2.0

package/config/eslintrc.js

@@ -1,8 +1,6 @@
-const path = require("path");
-
 // Assume `@wordpress/*` packages are available. This is because `calypso-build` is using
 // Dependency Extraction Webpack Plugin to use core WP packages instead of those from
-// node_modules. The packages should still be part of the project (so they are listed in this
+// node_modules. The packages should still be part of the project (they are listed in this
 // project's package.json) so that they are available in testing environment.
 // More on this:
 // - https://www.npmjs.com/package/@wordpress/dependency-extraction-webpack-plugin
@@ -36,12 +34,10 @@ module.exports = {
   rules: {
     "no-console": "off",
     camelcase: "off",
-    // Disallow importing or requiring packages that are not listed in package.json
-    // This prevents us from depending on transitive dependencies, which could break in unexpected ways.
-    "import/no-extraneous-dependencies": [
-      "error",
-      { packageDir: [".", path.resolve(__dirname, "../")] },
-    ],
+    // Some dependencies are injected by WP, and should not be declared in package.json (won't be used anyway).
+    // See https://github.com/WordPress/gutenberg/blob/e035f71/packages/dependency-extraction-webpack-plugin/README.md#behavior-with-scripts
+    // Unfortunately there's no "ignore" option for this rule, so it's disabled altogether.
+    "import/no-extraneous-dependencies": "off",
     "import/no-unresolved": ["error", { ignore: GLOBALLY_AVAILABLE_PACKAGES }],
     // There's a conflict with prettier here:
     "react/jsx-curly-spacing": "off",

package/package.json

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

package/src/executors/php-81.yml

@@ -0,0 +1,8 @@
+description: PHP executor
+docker:
+  - image: "cimg/php:<<parameters.tag>>"
+parameters:
+  tag:
+    default: 8.1-node
+    description: PHP image version
+    type: string

package/src/jobs/generate-docs.yml

@@ -1,10 +1,15 @@
 description: >
-  Generate documentation.
+  Generate documentation. This will create a new branch called docs and push the HTML documentation to it, as /docs directory.
+  To make this work with GH pages, visit <repo-url>/settings/pages, set branch to "docs", and folder to "/docs".
 
-executor: default
+executor: php-81
 
 steps:
   - checkout
+  - run:
+      name: Install dependencies
+      command: |
+        sudo apt-get update && sudo apt-get install -y graphviz plantuml
   - run:
       name: Download PHPDocumentor
       command: |
@@ -13,11 +18,13 @@ steps:
   - run:
       name: Generate documentation
       command: |
-        ./phpdocumentor -d ./includes -t ./docs
+        ./phpdocumentor run -d . -t ./docs
   - run:
       name: Switch to docs branch, commit, and push
       command: |
-        git co -b docs
-        git add docs
-        git commit -m "Update docs"
-        git push origin docs
+        git config user.name "${GIT_COMMITTER_NAME}"
+        git config user.email "${GITHUB_COMMITER_EMAIL}"
+        git checkout -b docs
+        git add -f docs
+        git commit -m "Update the docs"
+        git push "https://${GITHUB_TOKEN}@github.com/${CIRCLE_PROJECT_USERNAME}/${CIRCLE_PROJECT_REPONAME}.git" --force

package/src/jobs/lint-php.yml

@@ -1,7 +1,7 @@
 description: >
   Lint PHP files.
 
-executor: default
+executor: php-81
 
 steps:
   - checkout