Publish unreleased modules on push to main (#4)

Author: mcous

.eslintrc.cjs

@@ -7,6 +7,6 @@ module.exports = {
     node: true,
   },
   parserOptions: {
-    project: './tsconfig.json',
+    project: ['./tsconfig.json', './packages/*/tsconfig.json'],
   },
 };

.github/actions/setup/action.yml

@@ -6,6 +6,10 @@ inputs:
     description: 'Node.js version to install'
     default: '18'
 
+  registry-url:
+    description: 'Registry URL (required for publish)'
+    required: false
+
 runs:
   using: 'composite'
   steps:
@@ -16,6 +20,7 @@ runs:
       uses: actions/setup-node@v3
       with:
         node-version: ${{ inputs.node-version }}
+        registry-url: ${{ inputs.registry-url }}
         cache: pnpm
 
     - name: 'Install development dependencies'

.github/workflows/ci.yaml

@@ -13,7 +13,38 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+
       - name: 'Install 🔧'
         uses: ./.github/actions/setup
+
       - name: 'Run checks ✅'
         run: pnpm all
+
+  publish:
+    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+    needs: [check]
+    runs-on: ubuntu-latest
+    permissions:
+      # write permission required to push tags
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: 'Install 🔧'
+        uses: ./.github/actions/setup
+        with:
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: 'Build 🏗️'
+        run: pnpm build
+
+      - name: 'Configure Git for publish 🌴'
+        run: |
+          git config user.name github-actions
+          git config user.email [email protected]
+
+      - name: 'Publish packages 🚀'
+        run: ./scripts/publish.sh
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1 +1,3 @@
 node_modules
+pnpm-publish-summary.json
+*.d.cts

README.md

@@ -1,10 +1,22 @@
-# Viam Shared Web Project Config
-
-Shared configuration for web tooling:
-
-- [ESLint](./packages/eslint-config)
-- [Pretter](./packages/prettier-config)
-- [TypeScript](./packages/typescript-config)
+# Viam Shared JS/TS Config
+
+Shared configuration for JavaScript and TypeScript tools:
+
+| Tool                          | NPM Module                        | Version                                   |
+| ----------------------------- | --------------------------------- | ----------------------------------------- |
+| [ESLint][eslint docs]         | `@viamrobotics/eslint-config`     | [![eslint version][]][eslint npm]         |
+| [Prettier][prettier docs]     | `@viamrobotics/prettier-config`   | [![prettier version][]][prettier npm]     |
+| [TypeScript][typescript docs] | `@viamrobotics/typescript-config` | [![typescript version][]][typescript npm] |
+
+[eslint docs]: ./packages/eslint-config
+[eslint npm]: https://www.npmjs.com/package/@viamrobotics/eslint-config
+[eslint version]: https://img.shields.io/npm/v/@viamrobotics/eslint-config?style=flat-square
+[prettier docs]: ./packages/prettier-config
+[prettier npm]: https://www.npmjs.com/package/@viamrobotics/prettier-config
+[prettier version]: https://img.shields.io/npm/v/@viamrobotics/prettier-config?style=flat-square
+[typescript docs]: ./packages/typescript-config
+[typescript npm]: https://www.npmjs.com/package/@viamrobotics/typescript-config
+[typescript version]: https://img.shields.io/npm/v/@viamrobotics/typescript-config?style=flat-square
 
 ## Contributing
 
@@ -20,7 +32,7 @@ pnpm install
 Once your development dependencies are installed, you can verify that all checks and tests are passing:
 
 ```shell
-# run all checks
+# run all checks and builds
 pnpm all
 
 # check lints
@@ -32,6 +44,9 @@ pnpm check-types
 # check formatting
 pnpm check-format
 
+# build all packages
+pnpm build
+
 # auto-format (modifies files)
 pnpm format
 ```
@@ -41,4 +56,4 @@ pnpm format
 
 ### Releasing
 
-TK
+Modules in this repository are continuously deployed to npm from the `main` branch. To trigger a release, create a commit that bumps `version` in one or more `package.json` files and create a pull request to merge that commit into `main`.

package.json

@@ -9,10 +9,11 @@
   "license": "Apache-2.0",
   "type": "module",
   "scripts": {
-    "all": "concurrently -g pnpm:check-*",
+    "all": "concurrently -g pnpm:check-* pnpm:build",
     "check-format": "pnpm run _prettier-base --check",
     "check-lint": "eslint \"**/*.@(js|cjs|ts)\"",
     "check-types": "tsc",
+    "build": "pnpm run -r --aggregate-output build",
     "format": "pnpm run _prettier-base --write",
     "_prettier-base": "prettier \"**/*.@(js|cjs|ts|json|yaml|md)\""
   },

packages/eslint-config/package.json

@@ -3,10 +3,17 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "Common ESLint configuration for Viam projects.",
+  "types": "./base.d.cts",
   "exports": {
-    ".": "./base.cjs"
+    ".": {
+      "types": "./base.d.cts",
+      "default": "./base.cjs"
+    }
+  },
+  "scripts": {
+    "build": "tsc"
   },
   "repository": {
     "type": "git",

packages/eslint-config/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@viamrobotics/typescript-config",
+  "compilerOptions": {
+    "types": ["node"],
+    "declaration": true,
+    "emitDeclarationOnly": true
+  },
+  "include": ["./**/*.cjs"]
+}

packages/prettier-config/package.json

@@ -3,11 +3,17 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "Common Prettier configuration for Viam projects.",
+  "types": "./base.d.cts",
   "exports": {
-    ".": "./base.cjs",
-    "./svelte": "./svelte.cjs"
+    ".": {
+      "types": "./base.d.cts",
+      "default": "./base.cjs"
+    }
+  },
+  "scripts": {
+    "build": "tsc"
   },
   "repository": {
     "type": "git",

packages/prettier-config/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@viamrobotics/typescript-config",
+  "compilerOptions": {
+    "types": ["node"],
+    "declaration": true,
+    "emitDeclarationOnly": true
+  },
+  "include": ["./**/*.cjs"]
+}

packages/typescript-config/README.md

@@ -1,6 +1,6 @@
 # Shared TypeScript Config for Viam
 
-This module contains [Viam][]'s shared [TypeScript][] configurations for TypeScript v5. The main difference between the different configurations is their module resolution strategy.
+This module contains [Viam][]'s shared [TypeScript][] configurations for TypeScript v5.
 
 ```shell
 npm install --save-dev typescript @viamrobotics/typescript-config
@@ -11,7 +11,7 @@ npm install --save-dev typescript @viamrobotics/typescript-config
 
 ### Base config
 
-Use the [base config](./base.json) for generic TypeScript projects, including code that runs natively in Node.js or isomorphicaly, in both Node.js and the browser.
+Use the [base config](./tsconfig.base.json) for generic TypeScript projects, including code that runs natively in Node.js or isomorphicaly, in both Node.js and the browser.
 
 ```json
 // tsconfig.json

packages/typescript-config/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "Common TypeScript configuration for Viam projects.",
   "exports": {
     ".": "./tsconfig.base.json"

packages/typescript-config/tsconfig.base.json

@@ -1,6 +1,7 @@
 {
   "compilerOptions": {
     // use import/export and legacy node resolution logic
+    "target": "esnext",
     "module": "esnext",
     "moduleResolution": "node",
     "resolveJsonModule": true,

scripts/publish.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+set -e
+
+# publish all unpublished versions in the workspace
+pnpm publish --recursive --report-summary
+
+# read published packages
+tags=$(jq -r ".publishedPackages[] | .name + \"@\" + .version" < pnpm-publish-summary.json)
+
+# add a tag for each released version
+for tag in ${tags}; do
+  git tag -a "${tag}" -m "${tag}"
+done
+
+# push tags
+for tag in ${tags}; do
+  git push origin "${tag}"
+done

tsconfig.json

@@ -4,5 +4,5 @@
     "types": ["node"],
     "noEmit": true
   },
-  "include": ["./.*", "./**/*"]
+  "include": ["./**/.*"]
 }