Add release-plz (open-feature#63)

toddbaert · web-flow · commit ec729f4051ad · 2022-07-15T16:23:47.000-04:00
Signed-off-by: Todd Baert &lt;toddbaert@gmail.com&gt;
diff --git a/.github/workflows/lint-pr.yml b/.github/workflows/lint-pr.yml
@@ -0,0 +1,17 @@
+name: 'Lint PR'
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v4
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
@@ -0,0 +1,42 @@
+on:
+  push:
+    branches:
+      - main
+name: Run Release Please
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+
+    # Release-please creates a PR that tracks all changes
+    steps:
+      - uses: google-github-actions/release-please-action@v3
+        id: release
+        with:
+          command: manifest
+          token: ${{secrets.GITHUB_TOKEN}}
+          default-branch: main
+
+      # The logic below handles the npm publication:
+      - name: Checkout Repository
+        if: ${{ steps.release.outputs.releases_created }}
+        uses: actions/checkout@v2
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        if: ${{ steps.release.outputs.releases_created }}
+        with:
+          node-version: 16
+          registry-url: 'https://registry.npmjs.org'
+      - name: Build Packages
+        if: ${{ steps.release.outputs.releases_created }}
+        run: |
+          npm install
+          npm run build
+
+      # Release Please has already incremented versions and published tags, so we just
+      # need to publish all unpublished versions to NPM here
+      # Our scripts only publish versions that do not already exist.
+      - name: Publish to NPM
+        if: ${{ steps.release.outputs.releases_created }}
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+        run: npm run publish
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -0,0 +1,3 @@
+{
+  "libs/hooks/open-telemetry": "1.0.6-alpha"
+}
diff --git a/README.md b/README.md
@@ -10,6 +10,10 @@ The project includes:
 - [Providers](./libs/providers)
 - [Hooks](./libs/hooks)
 
+## Releases
+
+This repo uses _Release Please_ to release packages. Release Please sets up a running PR that tracks all changes for the library components, and maintains the versions according to [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), generated when [PRs are merged](https://github.com/amannn/action-semantic-pull-request). When Release Please's running PR is merged, any changed artifacts are published.
+
 ## License
 
 Apache 2.0 - See [LICENSE](./license) for more information.
diff --git a/libs/hooks/open-telemetry/package.json b/libs/hooks/open-telemetry/package.json
@@ -1,5 +1,18 @@
 {
   "name": "@openfeature/open-telemetry-hook",
-  "version": "0.0.1",
-  "type": "commonjs"
-}
+  "version": "1.0.6-alpha",
+  "type": "commonjs",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/open-feature/node-sdk-contrib.git",
+    "directory": "libs/hooks/open-telemetry"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "publish-if-not-exists": "cp $NPM_CONFIG_USERCONFIG .npmrc && if [[ $(npm show $npm_package_name@$npm_package_version version) = $(npm run current-version -s) ]]; then echo 'already published, skipping'; else npm publish --access public; fi",
+    "current-version": "echo $npm_package_version"
+  },
+  "license": "Apache-2.0"
+}
diff --git a/libs/hooks/open-telemetry/project.json b/libs/hooks/open-telemetry/project.json
@@ -5,16 +5,23 @@
   "targets": {
     "package": {
       "executor": "@nrwl/web:rollup",
-      "outputs": ["{options.outputPath}"],
+      "outputs": [
+        "{options.outputPath}"
+      ],
       "options": {
         "project": "libs/hooks/open-telemetry/package.json",
         "outputPath": "dist/libs/hooks/open-telemetry",
         "entryFile": "libs/hooks/open-telemetry/src/index.ts",
         "tsConfig": "libs/hooks/open-telemetry/tsconfig.lib.json",
         "compiler": "babel",
         "umdName": "OpenTelemetry",
-        "external": ["typescript"],
-        "format": ["cjs", "esm"],
+        "external": [
+          "typescript"
+        ],
+        "format": [
+          "cjs",
+          "esm"
+        ],
         "assets": [
           {
             "glob": "LICENSE",
@@ -31,18 +38,23 @@
     },
     "build": {
       "executor": "@nrwl/js:tsc",
-      "outputs": ["{options.outputPath}"],
+      "outputs": [
+        "{options.outputPath}"
+      ],
       "options": {
         "outputPath": "dist/libs/hooks/open-telemetry",
         "main": "libs/hooks/open-telemetry/src/index.ts",
         "tsConfig": "libs/hooks/open-telemetry/tsconfig.lib.json",
-        "assets": ["libs/hooks/open-telemetry/*.md"]
+        "assets": [
+          "libs/hooks/open-telemetry/*.md"
+        ]
       }
     },
     "publish": {
       "executor": "@nrwl/workspace:run-commands",
       "options": {
-        "command": "node tools/scripts/publish.mjs hooks-open-telemetry {args.ver} {args.tag}"
+        "command": "npm run publish-if-not-exists",
+        "cwd": "dist/libs/hooks/open-telemetry"
       },
       "dependsOn": [
         {
@@ -53,19 +65,25 @@
     },
     "lint": {
       "executor": "@nrwl/linter:eslint",
-      "outputs": ["{options.outputFile}"],
+      "outputs": [
+        "{options.outputFile}"
+      ],
       "options": {
-        "lintFilePatterns": ["libs/hooks/open-telemetry/**/*.ts"]
+        "lintFilePatterns": [
+          "libs/hooks/open-telemetry/**/*.ts"
+        ]
       }
     },
     "test": {
       "executor": "@nrwl/jest:jest",
-      "outputs": ["coverage/libs/hooks/open-telemetry"],
+      "outputs": [
+        "coverage/libs/hooks/open-telemetry"
+      ],
       "options": {
         "jestConfig": "libs/hooks/open-telemetry/jest.config.ts",
         "passWithNoTests": true
       }
     }
   },
   "tags": []
-}
+}
diff --git a/package.json b/package.json
@@ -1,11 +1,13 @@
 {
   "name": "node-sdk-contrib",
   "version": "0.0.0",
-  "license": "MIT",
+  "license": "Apache-2.0",
   "scripts": {
     "generate-hook": "nx workspace-generator open-feature hook",
     "generate-provider": "nx workspace-generator open-feature provider",
-    "test": "nx run-many --all --target=test"
+    "test": "nx run-many --all --target=test",
+    "build": "npx nx run-many --all --target=build",
+    "publish": "npx nx run-many --all --target=publish"
   },
   "private": true,
   "dependencies": {
@@ -37,4 +39,4 @@
     "ts-node": "~10.8.0",
     "typescript": "~4.7.2"
   }
-}
+}
diff --git a/release-please-config.json b/release-please-config.json
@@ -0,0 +1,13 @@
+{
+  "bootstrap-sha": "8ec3eb4db55b7c2d6c2d7edc7c7f3c147b47fd35",
+  "packages": {
+    "libs/hooks/open-telemetry": {
+      "releaseType": "node",
+      "prerelease": true,
+      "bumpMinorPreMajor": false,
+      "bumpPatchForMinorPreMajor": false,
+      "changelogPath": "CHANGELOG.md",
+      "versioning": "default"
+    }
+  }
+}
diff --git a/tools/generators/open-feature/index.ts b/tools/generators/open-feature/index.ts
@@ -77,6 +77,9 @@ export default async function (tree: Tree, schema: SchemaOptions) {
 
   updateProject(tree, projectRoot, name);
   updateTsConfig(tree, projectRoot);
+  updatePackage(tree, projectRoot);
+  updateReleasePleaseConfig(tree, projectRoot);
+  updateReleasePleaseManifest(tree, projectRoot);
   await formatFiles(tree);
 
   return () => {
@@ -143,17 +146,66 @@ function updateProject(tree: Tree, projectRoot: string, umdName: string) {
       },
     };
 
-    json.targets.publish.dependsOn[0].target = 'package';
+    // add publishing
+    json.targets['publish'] = {
+      executor: '@nrwl/workspace:run-commands',
+      options: {
+        command: 'npm run publish-if-not-exists',
+        cwd: `dist/${projectRoot}`,
+      },
+      dependsOn: [
+        {
+          projects: 'self',
+          target: 'package',
+        },
+      ],
+    };
     delete json.targets.build;
 
     return json;
   });
 }
 
+function updatePackage(tree: Tree, projectRoot: string) {
+  updateJson(tree, joinPathFragments(projectRoot, 'package.json'), (json) => {
+    json.scripts = {
+      'publish-if-not-exists':
+        "cp $NPM_CONFIG_USERCONFIG .npmrc && if [[ $(npm show $npm_package_name@$npm_package_version version) = $(npm run current-version -s) ]]; then echo 'already published, skipping'; else npm publish --access public; fi",
+      'current-version': 'echo $npm_package_version',
+    };
+
+    return json;
+  });
+}
+
 function updateTsConfig(tree: Tree, projectRoot: string) {
   updateJson(tree, joinPathFragments(projectRoot, 'tsconfig.json'), (json) => {
     json.compilerOptions.module = 'ES6';
 
     return json;
   });
 }
+
+function updateReleasePleaseConfig(tree: Tree, projectRoot: string) {
+  updateJson(tree, 'release-please-config.json', (json) => {
+    json.packages[projectRoot] = {
+      releaseType: 'node',
+      prerelease: true,
+      bumpMinorPreMajor: true,
+      bumpPatchForMinorPreMajor: false,
+      changelogPath: 'CHANGELOG.md',
+      versioning: 'default',
+    };
+
+    return json;
+  });
+}
+
+// this starts everything at 0.1.0
+function updateReleasePleaseManifest(tree: Tree, projectRoot: string) {
+  updateJson(tree, '.release-please-manifest.json', (json) => {
+    json[projectRoot] = '0.1.0';
+
+    return json;
+  });
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "libs/hooks/open-telemetry": "1.0.6-alpha"`
	`3`	`+}`