Add action: Link to docs

.github/actions/link-docs/action.yml

@@ -0,0 +1,11 @@
+name: 'Link to Docs'
+description: 'Add fresh links to API docs to the README and package.json'
+
+inputs:
+  version:
+    description: The SDK version
+    required: true
+
+runs:
+  using: 'node16'
+  main: './linkDocs.js'

.github/actions/link-docs/linkDocs.js

@@ -0,0 +1,31 @@
+const fs = require('fs')
+const execSync = require('child_process').execSync
+const core = require('@actions/core')
+
+const LINK_TOKEN = 'CI_REPLACE_LINK_DOCS'
+const README_FILE = 'README.MD'
+
+const version = core.getInput('version', {required: true})
+const homepage = `https://players.castlabs.com/react-dom/${version}/docs/`
+
+/**
+ * Set the "homepage" attribute in package.json
+ * @param {string} link
+ */
+function addLinkToPackageJson(link) {
+  execSync(`npm pkg set homepage=${link}`, { stdio: 'inherit' })
+}
+
+/**
+ * Replace token by link in the README.md file
+ * @param {string} link
+ * @param {string} token
+ */
+function addLinkToReadme(link, token) {
+  let content = fs.readFileSync(README_FILE, 'utf8')
+  content = content.replace(token, link)
+  fs.writeFileSync(README_FILE, content)
+}
+
+addLinkToReadme(homepage, LINK_TOKEN)
+addLinkToPackageJson(homepage)

.github/workflows/publish.yml

@@ -30,25 +30,7 @@ jobs:
       - name: Install Dependencies
         run: npm ci
 
-      - name: Write NPM RC File
-        run: |
-          echo '@castlabs:registry=https://registry.npmjs.org' > .npmrc
-          echo '//registry.npmjs.org/:_authToken=${NPM_TOKEN}' >> .npmrc
-
-      - name: Set Package Version
-        run: npm --no-git-tag-version --allow-same-version version ${{ env.VERSION }}
-
-      - name: Build
-        run: npm run build
-
-      # TODO remove the --dry-run
-      - name: Publish to NPM
-        run: npm publish --dry-run
-
-      - name: Add NPM Release Job summary
-        run: |
-          echo '### NPM Release' >> $GITHUB_STEP_SUMMARY
-          echo "Released version ${{ env.VERSION }} of https://www.npmjs.com/package/@castlabs/prestoplay-react-components" >> $GITHUB_STEP_SUMMARY
+    ## Publish the API docs
 
       - name: Build Storybook
         run: npm run build-storybook
@@ -70,3 +52,30 @@ jobs:
         run: |
           echo '### Docs' >> $GITHUB_STEP_SUMMARY
           echo "Published docs to https://players.castlabs.com/${{ env.WEB_PATH }}" >> $GITHUB_STEP_SUMMARY
+
+    ## Publish the NPM package
+
+      - name: Write NPM RC File
+        run: |
+          echo '@castlabs:registry=https://registry.npmjs.org' > .npmrc
+          echo '//registry.npmjs.org/:_authToken=${NPM_TOKEN}' >> .npmrc
+
+      - name: Set Package Version
+        run: npm --no-git-tag-version --allow-same-version version ${{ env.VERSION }}
+
+      - name: Link to API Docs
+        uses: ./.github/actions/link-docs
+        with:
+          version: ${{ env.VERSION }}
+
+      - name: Build
+        run: npm run build
+
+      # TODO remove the --dry-run
+      - name: Publish to NPM
+        run: npm publish --dry-run
+
+      - name: Add NPM Release Job summary
+        run: |
+          echo '### NPM Release' >> $GITHUB_STEP_SUMMARY
+          echo "Released version ${{ env.VERSION }} of https://www.npmjs.com/package/@castlabs/prestoplay-react-components" >> $GITHUB_STEP_SUMMARY