update push-release action to publish spfx solution to release notes

Author: nmetulev

.github/ISSUE_TEMPLATE/new-release--internal-use-only-.md

@@ -9,18 +9,26 @@ assignees: ''
 
 This issue tracks the publishing progress for a release. It will get updated as tasks are completed
 
-- [ ] Write blog post
-- [ ] Prep the release branch
-  - [ ] Merge main into 'release/latest'
-  - [ ] Update the package versions to new version
-- [ ] Publish release to GitHub
-  - [ ] Write release notes
-    - [ ] Write summary for top of release notes
-  - [ ] Publish release notes
-- [ ] Publish docs
+#### Blog Post
+  - [ ] Author and stage
+  - [ ] Publish
+
+#### GitHub Release Notes
+  - [ ] Author draft release notes
+  - [ ] Author release notes summary
+  - [ ] Publish
+
+#### Docs
   - [ ] Create docs PR
+  - [ ] Get docs PR reviewed and approved
   - [ ] Merge docs PR
-- [ ] Publish storybook from release branch
-- [ ] Publish NPM package from release branch
-- [ ] Merge release branch to main
-- [ ] Publish release blog post
+
+#### Release
+  - [ ] Ensure `main` is up to date with `release/latest`
+  - [ ] Ensure `./package.json` version in `main` is correct
+  - [ ] Merge `main` in `release/latest` - this will invoke the release workflow
+  - [ ] Approve workflow to publish npm packages
+  - [ ] Validate npm packages are published
+  - [ ] Validate mgt.dev is updated
+  - [ ] Validate GitHub release contains `mgt-spfx` asset
+  - [ ] Increment `./package.json` version in main for building preview packages 

.github/workflows/push-release.yml

@@ -56,34 +56,22 @@ jobs:
           node-version: ${{ matrix.node-version }}
           registry-url: 'https://registry.npmjs.org'
 
-      - name: Get latest version from npm
-        id: latest-version
-        run: echo ::set-output name=version::$(npm show @microsoft/mgt version)
-
-      - name: Get current package version
-        id: package-version
-        uses: martinbeentjes/npm-get-version-action@master
-
       - name: Build 🛠
         run: |
           npm install -g yarn lerna
           yarn
           yarn build
 
-      # commenting out for now until we can properly test this during a release
-      # - name: Update package version
-      #   run: node scripts/setVersion.js
+      - name: Update package version
+        run: node scripts/setVersion.js
 
-      # - name: Publish npm packages
-      #   run: lerna exec --scope @microsoft/* -- "npm publish --access=public"
-      #   env:
-      #     NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Publish npm packages
+        run: lerna exec --scope @microsoft/* -- "npm publish --access=public"
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
-      # - name: Upload a Build Artifact - mgt-spfx Solution
-      #   uses: actions/upload-artifact@v2
-      #   with:
-      #     name: mgt-spfx solution
-      #     path: packages/mgt-spfx/sharepoint/*
+      - name: Attach mgt-spfx solution to GitHub release
+        run: node scripts/uploadSpfxSolution.js ${{secrets.GITHUB_TOKEN}} ${{needs.version.outputs.package-version}}
 
   storybook:
     runs-on: ubuntu-latest

package.json

@@ -115,7 +115,8 @@
     "web-component-analyzer": "^1.1.6",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "tslint-microsoft-contrib": "^6.2.0"
+    "tslint-microsoft-contrib": "^6.2.0",
+    "@octokit/rest": "^18.5.3"
   },
   "husky": {
     "hooks": {

scripts/uploadSpfxSolution.js

@@ -0,0 +1,71 @@
+// uploads the mgt-spfx solution to a GitHub release
+// this script is called by a github workflow to automate
+// uploading the solution during a release of mgt
+
+const { Octokit } = require("@octokit/rest");
+const fs = require('fs');
+
+if (process.argv.length < 4) {
+  console.log('usage: uploadSpfxSolution.js <github_token> <package_version>');
+
+  return;
+}
+
+const auth = process.argv[2];
+const version = process.argv[3];
+const repo = 'microsoft-graph-toolkit';
+const owner = 'microsoftgraph';
+const assetPath = 'packages/mgt-spfx/sharepoint/solution/mgt-spfx.sppkg';
+
+const octokit = new Octokit({ auth });
+
+(async () => {
+
+  const releases = await octokit.rest.repos.listReleases({
+    owner,
+    repo
+  })
+
+  const filteredReleases = releases.data.filter(r => r.name.includes(version));
+  let release;
+
+  if (!filteredReleases.length) {
+    console.log(`No release found for ${version} - creating a new draft release`);
+    release = (await octokit.rest.repos.createRelease({
+      owner,
+      repo,
+      tag_name: 'v' + version,
+      name: 'v' + version,
+      draft: true
+    })).data;
+  } else {
+    console.log(`found existing release for ${version}`);
+    release = filteredReleases[0];
+  }
+
+  const file = fs.readFileSync(assetPath);
+  const name = `mgt-spfx-${version}.sppkg`;
+
+  if (release.assets && release.assets.length) {
+    const asset = release.assets.filter(a => a.name === name)[0];
+    if (asset) {
+      console.log(`found existing asset for release ${version} - deleting`)
+      await octokit.rest.repos.deleteReleaseAsset({
+        owner,
+        repo,
+        asset_id: asset.id
+      });
+    }
+  }
+
+  console.log(`attaching ${assetPath} as ${name} to release`)
+  await octokit.rest.repos.uploadReleaseAsset({
+    owner,
+    repo,
+    release_id: release.id,
+    data: file,
+    name: `mgt-spfx-${version}.sppkg`
+  });
+
+  console.log('done')
+})();