feat: use release please manifest configuration (#164)

npm · Aug 25, 2022 · 95118ec · 95118ec
1 parent e5d3d0e
commit 95118ec
Show file tree

Hide file tree

Showing 20 changed files with 339 additions and 175 deletions.
diff --git a/.github/matchers/tap.json b/.github/matchers/tap.json
@@ -29,4 +29,4 @@
       ]
     }
   ]
-}
+}
diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
@@ -8,19 +8,50 @@ on:
       - main
       - latest
 
+permissions:
+  contents: write
+  pull-requests: write
+
 jobs:
   release-please:
     runs-on: ubuntu-latest
+    outputs:
+      prs: ${{ steps.release.outputs.prs }}
     steps:
       - uses: google-github-actions/release-please-action@v3
         id: release
         with:
-          release-type: node
-          changelog-types: >
-            [
-              {"type":"feat","section":"Features","hidden":false},
-              {"type":"fix","section":"Bug Fixes","hidden":false},
-              {"type":"docs","section":"Documentation","hidden":false},
-              {"type":"deps","section":"Dependencies","hidden":false},
-              {"type":"chore","hidden":true}
-            ]
+          command: manifest
+
+  update-prs:
+    needs: release-please
+    if: needs.release-please.outputs.prs
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        pr: ${{ fromJSON(needs.release-please.outputs.prs) }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup git user
+        run: |
+          git config --global user.email "npm-cli+bot@github.com"
+          git config --global user.name "npm CLI robot"
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+      - name: Update npm to latest
+        run: npm i --prefer-online --no-fund --no-audit -g npm@latest
+      - run: npm -v
+      - name: Update PR ${{ matrix.pr.number }} dependencies and commit
+        if: steps.release.outputs.pr
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh pr checkout ${{ matrix.pr.number }}
+          npm run resetdeps
+          title="${{ matrix.pr.title }}"
+          # get the dependency spec from the pr title
+          # get everything after ': release ' + replace space with @
+          dep_spec=$(echo "${title##*: release }" | tr ' ' @)
+          git commit -am "deps: $dep_spec"
+          git push
diff --git a/.gitignore b/.gitignore
@@ -19,8 +19,10 @@
 !/.github/
 !/.gitignore
 !/.npmrc
+!/.release-please-manifest.json
 !/CODE_OF_CONDUCT.md
 !/SECURITY.md
 !/bin/
 !/lib/
 !/package.json
+!/release-please-config.json
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -0,0 +1,3 @@
+{
+  ".": "3.6.0"
+}
diff --git a/lib/content/index.js b/lib/content/index.js
@@ -1,5 +1,26 @@
 const { name: NAME, version: LATEST_VERSION } = require('../../package.json')
 
+const releasePlease = () => ({
+  '.github/workflows/release-please.yml': {
+    file: 'release-please.yml',
+    filter: (o) => !o.pkg.private,
+  },
+  '.release-please-manifest.json': {
+    file: 'release-please-manifest.json',
+    filter: (o) => !o.pkg.private,
+    parser: (p) => class NoCommentJson extends p.JsonMerge {
+      comment = null
+    },
+  },
+  'release-please-config.json': {
+    file: 'release-please-config.json',
+    filter: (o) => !o.pkg.private,
+    parser: (p) => class NoCommentJson extends p.JsonMerge {
+      comment = null
+    },
+  },
+})
+
 // Changes applied to the root of the repo
 const rootRepo = {
   add: {
@@ -14,10 +35,7 @@ const rootRepo = {
     '.github/workflows/codeql-analysis.yml': 'codeql-analysis.yml',
     '.github/workflows/post-dependabot.yml': 'post-dependabot.yml',
     '.github/workflows/pull-request.yml': 'pull-request.yml',
-    '.github/workflows/release-please.yml': {
-      file: 'release-please.yml',
-      filter: (o) => !o.pkg.private,
-    },
+    ...releasePlease(),
   },
 }
 
@@ -43,10 +61,7 @@ const rootModule = {
 // Changes for each workspace but applied to the root of the repo
 const workspaceRepo = {
   add: {
-    '.github/workflows/release-please-{{pkgNameFs}}.yml': {
-      file: 'release-please.yml',
-      filter: (o) => !o.pkg.private,
-    },
+    ...releasePlease(true),
     '.github/workflows/ci-{{pkgNameFs}}.yml': 'ci.yml',
   },
 }

diff --git a/lib/content/release-please-config.json b/lib/content/release-please-config.json
@@ -0,0 +1,13 @@
+{
+  "separate-pull-requests": true,
+  "changelog-sections":             [
+    {"type":"feat","section":"Features","hidden":false},
+    {"type":"fix","section":"Bug Fixes","hidden":false},
+    {"type":"docs","section":"Documentation","hidden":false},
+    {"type":"deps","section":"Dependencies","hidden":false},
+    {"type":"chore","hidden":true}
+  ],
+  "packages": {
+    "{{#unless pkgRelPath}}.{{/unless}}{{pkgRelPath}}": {}
+  }
+}
diff --git a/lib/content/release-please-manifest.json b/lib/content/release-please-manifest.json
@@ -0,0 +1,3 @@
+{
+  "{{#unless pkgRelPath}}.{{/unless}}{{pkgRelPath}}": "{{pkg.version}}"
+}
diff --git a/lib/content/release-please.yml b/lib/content/release-please.yml
@@ -1,56 +1,47 @@
-name: Release Please {{~#if isWorkspace}} - {{pkgName}}{{/if}}
+name: Release Please
 
 on:
   push:
-    {{#if pkgRelPath}}
-    paths:
-      - {{pkgRelPath}}/**
-    {{/if}}
     branches:
       {{#each branches}}
       - {{.}}
       {{/each}}
 
-{{#if isWorkspace}}
 permissions:
   contents: write
   pull-requests: write
-{{/if}}
 
 jobs:
   release-please:
     runs-on: ubuntu-latest
+    outputs:
+      prs: $\{{ steps.release.outputs.prs }}
     steps:
       - uses: google-github-actions/release-please-action@v3
         id: release
         with:
-          release-type: node
-          {{#if pkgRelPath}}
-          monorepo-tags: true
-          path: {{pkgRelPath}}
-          # name can be removed after this is merged
-          # https://github.com/google-github-actions/release-please-action/pull/459
-          package-name: "{{pkgName}}"
-          {{/if}}
-          changelog-types: >
-            [
-              {{#each changelogTypes}}
-              {{{json .}}}{{#unless @last}},{{/unless}}
-              {{/each}}
-            ]
-      {{#if isWorkspace}}
+          command: manifest
+
+  update-prs:
+    needs: release-please
+    if: needs.release-please.outputs.prs
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        pr: $\{{ fromJSON(needs.release-please.outputs.prs) }}
+    steps:
       {{> setupGit}}
       {{> setupNode}}
-      - name: Update package-lock.json and commit
+      - name: Update PR $\{{ matrix.pr.number }} dependencies and commit
         if: steps.release.outputs.pr
         env:
           GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}
         run: |
-          gh pr checkout $\{{ fromJSON(steps.release.outputs.pr).number }}
+          gh pr checkout $\{{ matrix.pr.number }}
           npm run resetdeps
-          title="$\{{ fromJSON(steps.release.outputs.pr).title }}"
-          # get the version from the pr title
-          # get everything after the last space
-          git commit -am "deps: {{pkgName}}@${title##* }"
+          title="$\{{ matrix.pr.title }}"
+          # get the dependency spec from the pr title
+          # get everything after ': release ' + replace space with @
+          dep_spec=$(echo "${title##*: release }" | tr ' ' @)
+          git commit -am "deps: $dep_spec"
           git push
-      {{/if}}
diff --git a/lib/util/parser.js b/lib/util/parser.js
@@ -198,7 +198,7 @@ class Json extends Base {
   comment = (c) => ({ [`//${this.options.config.__NAME__}`]: c })
 
   toString (s) {
-    return JSON.stringify(s, (_, v) => v === this.DELETE ? undefined : v, 2)
+    return JSON.stringify(s, (_, v) => v === this.DELETE ? undefined : v, 2).trim() + '\n'
   }
 
   parse (s) {

diff --git a/release-please-config.json b/release-please-config.json
@@ -0,0 +1,32 @@
+{
+  "separate-pull-requests": true,
+  "changelog-sections": [
+    {
+      "type": "feat",
+      "section": "Features",
+      "hidden": false
+    },
+    {
+      "type": "fix",
+      "section": "Bug Fixes",
+      "hidden": false
+    },
+    {
+      "type": "docs",
+      "section": "Documentation",
+      "hidden": false
+    },
+    {
+      "type": "deps",
+      "section": "Dependencies",
+      "hidden": false
+    },
+    {
+      "type": "chore",
+      "hidden": true
+    }
+  ],
+  "packages": {
+    ".": {}
+  }
+}