Add template for npm package

.github/workflows/validate.yml

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

README.md

@@ -152,6 +152,10 @@ 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.
 
+- `private-npm-package`
+
+  Setup new npm modules on SEEK-jobs using semantic release pipeline.
+
 - `github →` (experimental)
 
   BYO starter repo!

scripts/test-template.sh

@@ -22,6 +22,8 @@ yarn skuba init << EOF
     "devBuildkiteQueueName": "my-account-dev:cicd",
     "devGantryEnvironmentName": "dev",
     "gitHubTeamName": "@my-org/my-team",
+    "moduleName":"module",
+    "fullModuleName": "my-first-module",
     "prodAwsAccountId": "000000000000",
     "prodBuildkiteQueueName": "my-account-prod:cicd",
     "prodGantryEnvironmentName": "prod",

src/cli/init/prompts.ts

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

src/cli/release.ts

@@ -0,0 +1,5 @@
+import { exec } from '../utils/exec';
+
+export const release = async () => {
+  await exec('semanticRelease', '--success', 'false');
+};

src/utils/command.ts

@@ -20,6 +20,7 @@ export const COMMAND_LIST = [
   'help',
   'init',
   'lint',
+  'release',
   'start',
   'test',
   'version',

template/private-npm-package/.buildkite/pipeline.yml

@@ -0,0 +1,4 @@
+steps:
+  - command: aws s3 cp s3://seek-npm-package-buildkite-pipeline/pipeline-latest.sh - | bash | buildkite-agent pipeline upload
+    agents:
+      queue: artefacts:npm

template/private-npm-package/.npmignore

@@ -0,0 +1,3 @@
+node_modules
+npm-debug.log
+.DS_Store

template/private-npm-package/README.md

@@ -0,0 +1,64 @@
+# <%- moduleName %>
+
+This project is powered by the [skuba](https://github.com/SEEK-OSS/skuba).
+
+<!--
+
+## Table of contents
+
+- [Usage](#usage)
+- [Design](#design)
+- [Development](#development)
+- [Support](#support)
+
+## Usage
+
+...
+
+## Design
+
+...
+
+## Development
+
+...
+
+## Support
+
+...
+
+-->
+
+To publish your module to npm and release notes to GitHub:
+
+## Release
+
+While a Buildkite pipeline for CI/CD is generated out of the box, there are some additional steps to get semantic-release working:
+
+<https://github.com/SEEK-Jobs/npm-package-buildkite-pipeline#installing-on-your-repository>
+
+### 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].
+
+[distribution tags]: https://docs.npmjs.com/adding-dist-tags-to-packages
+
+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:
+
+<https://github.com/semantic-release/semantic-release/#triggering-a-release>

template/private-npm-package/_.nvmrc

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

template/private-npm-package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "<%- fullModuleName %>",
+  "description": "<%- description %>",
+  "version": "0.0.0-semantically-released",
+  "main": "lib-commonjs",
+  "module": "lib-es2015",
+  "typings": "lib-types",
+  "files": [
+    "lib"
+  ],
+  "sideEffects": false,
+  "license": "UNLICENSED",
+  "scripts": {
+    "build": "skuba build",
+    "commit": "skuba commit",
+    "format": "skuba format",
+    "format:check": "skuba format check",
+    "lint": "skuba lint",
+    "prerelease": "skuba build",
+    "release": "skuba release",
+    "test": "echo \"No tests for now\""
+  },
+  "repository": {
+    "type": "git"
+  }
+}

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

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

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

@@ -0,0 +1,4 @@
+export default (): void => {
+  /* eslint-disable-next-line no-console */
+  console.log('<%- moduleName %>');
+};