Add oss-npm-package template

.changeset/swift-dryers-watch.md

@@ -0,0 +1,7 @@
+---
+'skuba': minor
+---
+
+**template/oss-npm-package:** Add new template
+
+This is intended for [seek-oss](https://github.com/seek-oss) projects.

.github/workflows/validate.yml

@@ -41,6 +41,7 @@ jobs:
           - greeter
           - koa-rest-api
           - lambda-sqs-worker
+          - oss-npm-package
           - private-npm-package
     steps:
       - name: Check out repo

README.md

@@ -152,10 +152,17 @@ This initialises a new directory and Git repository.
   a message queue is employed between the source topic and the Lambda function,
   and unprocessed events are sent to a dead-letter queue for manual triage.
 
+- `oss-npm-package`
+
+  A public npm package published via [semantic-release] pipeline.
+
+  This is intended for [seek-oss] projects.
+
 - `private-npm-package`
 
-  Set up a new private npm module published using a semantic release pipeline.
-  At the moment this only supports the `@seek` private npm org.
+  A private npm package published via [semantic-release] pipeline.
+
+  This is intended for [SEEK-Jobs] projects under the `@seek` npm org.
 
 - `github →` (experimental)
 
@@ -167,6 +174,9 @@ This initialises a new directory and Git repository.
 [aws lambda]: https://tech-strategy.ssod.skinfra.xyz/docs/v1/technology.html#lambda
 [koa]: https://koajs.com/
 [resource api]: https://tech-strategy.ssod.skinfra.xyz/docs/v1/components.html#resource-api
+[seek-jobs]: https://github.com/SEEK-Jobs
+[seek-oss]: https://github.com/seek-oss
+[semantic-release]: https://github.com/semantic-release/semantic-release/
 [serverless]: https://serverless.com/
 [worker]: https://tech-strategy.ssod.skinfra.xyz/docs/v1/components.html#worker
 

src/cli/init/prompts.ts

@@ -77,6 +77,7 @@ export const TEMPLATE_PROMPT = new Select({
     'greeter',
     'koa-rest-api',
     'lambda-sqs-worker',
+    'oss-npm-package',
     'private-npm-package',
     'github →',
   ] as const,

template/oss-npm-package/.github/workflows/release.yml

@@ -0,0 +1,34 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - beta
+      - master
+
+jobs:
+  release:
+    name: Publish & Deploy
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@master
+        with:
+          fetch-depth: 0
+          lfs: true
+
+      - name: Set up Node.js 12.x
+        uses: actions/setup-node@master
+        with:
+          node-version: 12.x
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Publish to npm
+        run: yarn release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.SEEK_OSS_CI_NPM_TOKEN }}

template/oss-npm-package/.github/workflows/validate.yml

@@ -0,0 +1,31 @@
+name: Validate
+
+on:
+  - pull_request
+  - push
+
+jobs:
+  validate:
+    name: Lint & Test
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@master
+        with:
+          lfs: true
+
+      - name: Set up Node.js 12.x
+        uses: actions/setup-node@master
+        with:
+          node-version: 12.x
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Lint
+        run: yarn lint
+
+      - name: Test
+        run: yarn test

template/oss-npm-package/.nvmrc

@@ -0,0 +1 @@
+lts/*

template/oss-npm-package/LICENSE

@@ -0,0 +1,21 @@
+### MIT License
+
+Copyright (c) 2020 SEEK
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

template/oss-npm-package/README.md

@@ -0,0 +1,119 @@
+# <%- moduleName %>
+
+[![Powered by skuba](https://img.shields.io/badge/🤿%20skuba-powered-009DC4)](https://github.com/seek-oss/skuba)
+
+This package is intended to be public on [seek-oss].
+To create an internal package,
+run `skuba init` and select the `private-npm-package` template.
+
+Please read [SEEK's Open Source RFC] before proceeding.
+
+## Table of contents
+
+- [API](#api)
+- [Development](#development)
+- [Release](#release)
+
+## API
+
+### `log`
+
+Writes "<%- moduleName %>" to stdout.
+Thrilling stuff.
+
+```typescript
+import { log } from '<%- moduleName %>';
+
+log();
+```
+
+## Development
+
+### Prerequisites
+
+- Node.js LTS
+- Yarn 1.x
+
+```shell
+yarn install
+```
+
+### Test
+
+```shell
+yarn test
+```
+
+### Lint
+
+```shell
+# fix
+yarn format
+
+# check
+yarn lint
+```
+
+### Package
+
+```shell
+# compile source
+yarn build
+
+# review bundle
+npm pack
+```
+
+## Release
+
+This package is published to the public npm registry with a GitHub Actions [release workflow].
+
+The workflow runs on select branches:
+
+```yaml
+on:
+  push:
+    branches:
+      # add others as necessary
+      - beta
+      - master
+      # - alpha
+```
+
+It depends on this repo being hosted on [seek-oss] with access to the `SEEK_OSS_CI_NPM_TOKEN` GitHub secret.
+
+Request access in `#open-source` on Slack:
+
+```text
+Hi, I’m publishing a new package from seek-oss/<%- moduleName %>. May I have access to the SEEK_OSS_CI_NPM_TOKEN organisation secret?
+```
+
+### Releasing latest
+
+Commits to the `master` branch will be released with the `latest` tag,
+which is the default used when running `npm install` or `yarn install`.
+
+### Releasing other dist-tags
+
+**[semantic-release]** prescribes a branch-based workflow for managing [distribution tags].
+
+You can push to other branches to manage betas, maintenance updates to prior major versions, and more.
+
+Here are some branches that **semantic-release** supports by default:
+
+| Git branch | npm dist-tag |
+| :--------- | :----------- |
+| master     | latest       |
+| alpha      | alpha        |
+| beta       | beta         |
+| next       | next         |
+| 1.x        | release-1.x  |
+
+For more information, see the **semantic-release** docs on [triggering a release].
+
+[distribution tags]: https://docs.npmjs.com/adding-dist-tags-to-packages
+[release workflow]: .github/workflows/release.yml
+[seek-oss]: https://github.com/seek-oss
+[seek's open source rfc]: https://rfc.skinfra.xyz/RFC016-Open-Source.html
+[semantic-release]: https://github.com/semantic-release/semantic-release
+[triggering a release]: https://github.com/semantic-release/semantic-release/#triggering-a-release

template/oss-npm-package/_package.json

@@ -0,0 +1,26 @@
+{
+  "dependencies": {},
+  "description": "<%- description %>",
+  "devDependencies": {
+    "skuba": "*"
+  },
+  "files": ["lib*/**/*.d.ts", "lib*/**/*.js", "lib*/**/*.js.map"],
+  "license": "MIT",
+  "main": "./lib-commonjs/index.js",
+  "module": "./lib-es2015/index.js",
+  "name": "<%- moduleName %>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/<%- orgName %>/<%- repoName %>.git"
+  },
+  "scripts": {
+    "build": "skuba build-package",
+    "format": "skuba format",
+    "lint": "skuba lint",
+    "release": "yarn build && skuba release",
+    "test": "skuba test"
+  },
+  "sideEffects": false,
+  "types": "./lib-types/index.d.ts",
+  "version": "0.0.0-semantically-released"
+}

template/oss-npm-package/skuba.template.js

@@ -0,0 +1,20 @@
+/**
+ * Run `skuba configure` to finish templating and remove this file.
+ */
+
+module.exports = {
+  entryPoint: 'src/index.ts',
+  fields: [
+    {
+      name: 'moduleName',
+      message: 'Module name',
+      initial: 'my-first-module',
+    },
+    {
+      name: 'description',
+      message: 'Description',
+      initial: 'This is my first module',
+    },
+  ],
+  type: 'package',
+};

template/oss-npm-package/src/index.test.ts

@@ -0,0 +1,5 @@
+import { log } from './index';
+
+describe('app', () => {
+  it('defines a log function', () => expect(log).toBeDefined());
+});

template/oss-npm-package/src/index.ts

@@ -0,0 +1,3 @@
+export const log = () =>
+  /* eslint-disable-next-line no-console */
+  console.log('<%- moduleName %>');