feat: automatic versioning when release published [gh-516]

.github/release.yml

@@ -0,0 +1,20 @@
+changelog:
+ exclude:
+ labels:
+ - ignore-for-release
+ categories:
+ - title: New Features
+ labels:
+ - enhancement
+ - title: Bug Fixes
+ labels:
+ - bug
+ - title: Other Changes
+ labels:
+ - '*'
+ exclude:
+ labels:
+ - dependencies
+ - title: Improvements
+ labels:
+ - "dependencies"

.github/workflows/release.yml

@@ -1,9 +1,10 @@
 name: Publish Package to npmjs
 on:
  release:
- types: [created]
+ types: [published]
 jobs:
- build:
+ # Build package and publish a prerelease
+ prerelease:
  permissions:
  id-token: write
  runs-on: ubuntu-latest
@@ -14,12 +15,79 @@ jobs:
  with:
  node-version: '16.x'
  registry-url: 'https://registry.npmjs.org'
+ env:
+ NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
  # Ensure that the README is published with the package
  - run: rm -f packages/cli/README.md && cp README.md packages/cli
  - run: npm ci
- - run: npm publish --provenance --workspace packages/cli
+ - name: Set version and publish prerelease for 'cli' package
+ run: |
+ npm --no-git-tag-version version ${{ github.event.release.tag_name }}-prerelease --workspace packages/cli
+ npm publish --provenance --workspace packages/cli --tag prerelease
+ - name: Set version and publish prerelease for 'create-cli' package
+ run: |
+ npm --no-git-tag-version version ${{ github.event.release.tag_name }}-prerelease --workspace packages/create-cli
+ npm publish --provenance --workspace packages/create-cli --tag prerelease
+ - name: Output prerelease packages versions
+ run: |
+ npm pkg get version --workspace packages/cli
+ npm pkg get version --workspace packages/create-cli
+ # Slack failure alert
+ - name: Slack Failure Notification
+ if: ${{ failure() }}
+ uses: rtCamp/action-slack-notify@v2
+ env:
+ SLACK_USERNAME: Checkly Github Bot
+ SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+ SLACK_CHANNEL: cli
+ SLACK_ICON: https://github.com/checkly.png?size=48
+ SLACK_COLOR: ${{ job.status }}
+ SLACK_TITLE: ':red_circle: NPM prerelease failed'
+ SLACK_MESSAGE: by ${{ github.actor }}
+ SLACK_FOOTER: ''
+ # Slack success alert
+ - name: Slack Success Notification
+ if: ${{ success() }}
+ uses: rtCamp/action-slack-notify@v2
+ env:
+ SLACK_USERNAME: Checkly Github Bot
+ SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+ SLACK_CHANNEL: cli
+ SLACK_ICON: https://github.com/checkly.png?size=48
+ SLACK_COLOR: ${{ job.status }}
+ SLACK_TITLE: ':white_check_mark: NPM prerelease succeeded'
+ SLACK_MESSAGE: by ${{ github.actor }}
+ SLACK_FOOTER: ''
+ # Publish package to NPM
+ release:
+ runs-on: ubuntu-latest
+ environment: production
+ needs: prerelease
+ steps:
+ - uses: actions/checkout@v3
+ with:
+ ref: main
+ - uses: actions/setup-node@v3
+ with:
+ node-version: '16.x'
+ registry-url: 'https://registry.npmjs.org'
  env:
  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+ # Ensure that the README is published with the package
+ - run: rm -f packages/cli/README.md && cp README.md packages/cli
+ - run: npm ci
+ - name: Set version and publish 'cli' package
+ run: |
+ npm --no-git-tag-version version ${{ github.event.release.tag_name }} --workspace packages/cli
+ npm publish --provenance --workspace packages/cli
+ - name: Set version and publish 'create-cli' package
+ run: |
+ npm --no-git-tag-version version ${{ github.event.release.tag_name }} --workspace packages/create-cli
+ npm publish --provenance --workspace packages/create-cli
+ - name: Output final packages versions
+ run: |
+ npm pkg get version --workspace packages/cli
+ npm pkg get version --workspace packages/create-cli
  # Slack failure alert
  - name: Slack Failure Notification
  if: ${{ failure() }}
@@ -30,7 +98,7 @@ jobs:
  SLACK_CHANNEL: cli
  SLACK_ICON: https://github.com/checkly.png?size=48
  SLACK_COLOR: ${{ job.status }}
- SLACK_TITLE: ':red_circle: NPM release failed'
+ SLACK_TITLE: ':red_circle: NPM publish failed'
  SLACK_MESSAGE: by ${{ github.actor }}
  SLACK_FOOTER: ''
  # Slack success alert
@@ -43,6 +111,6 @@ jobs:
  SLACK_CHANNEL: cli
  SLACK_ICON: https://github.com/checkly.png?size=48
  SLACK_COLOR: ${{ job.status }}
- SLACK_TITLE: ':white_check_mark: NPM release succeeded'
+ SLACK_TITLE: ':white_check_mark: NPM publish succeeded'
  SLACK_MESSAGE: by ${{ github.actor }}
  SLACK_FOOTER: ''

CONTRIBUTING.md

@@ -19,6 +19,8 @@ When running commands from the `packages/create-cli` directory, the `--workspace
 
 ## Running locally
 
+Use `CHECKLY_CLI_VERSION` environment variable to set the latest version you want to test.
+
 You can configure the stage (`production`, `staging`, `development` or `local`) using `CHECKLY_ENV` environment variable. Use `CHECKLY_ENV=local` if you want to point the API URL to your local backend `http://localhost:3000`.
 
 Also, you can use the `watch` mode to compile during your coding. You can use the following command to start your local environment:
@@ -66,23 +68,15 @@ npm install [email protected].<PR-NUMBER>.<COMMIT_SHORT_SHA>
 
 ## Releasing
 
-### Releasing `checkly` (CLI)
-
-To release the project to NPM:
-
-1. Update the `version` field in the [CLI package.json](./packages/cli/package.json)
-2. Create a new release in GitHub [here](https://github.com/checkly/checkly-cli/releases/new)
-
-The new version will then automatically be released by the corresponding GitHub action [here](https://github.com/checkly/checkly-cli/actions/workflows/release.yml).
+### Releasing `checkly` packages
 
-### Releasing `create-checkly`
-To release the [create-checkly](https://www.npmjs.com/package/create-checkly) package:
+Both packages [checkly](https://www.npmjs.com/package/checkly) and [create-cli](https://www.npmjs.com/package/create-checkly) are built and published by the corresponding GitHub action [here](https://github.com/checkly/checkly-cli/actions/workflows/release.yml).
 
-1. Update the `version` field in the [create-cli package.json](./packages/create-cli/package.json)
-2. Trigger the [GitHub action](https://github.com/checkly/checkly-cli/actions/workflows/release-create-package.yml)
- * Only release from `main`
+To release packages to NPM:
 
-The new version will then be built and published to NPM.
+1. Publish a Github Release with a valid tag `v#.#.#` and click the `Generate release notes` button to auto-generate notes following format defined [here](https://github.com/checkly/checkly-cli/blob/main/.github/release.yml) 
+2. When release is published the Github action is triggered. It builds and publishes `v#.#.#-prerelease` prereleases (for both packages).
+3. A `production` deployment will be waiting for approval. After it's approved, the `v#.#.#` version will be published and set as `latest`
 
 ## Style Guide
 

README.md

@@ -40,4 +40,6 @@ Official docs are over at [checklyhq.com/docs/cli](https://checklyhq.com/docs/cl
 
 # Local Development
 
+Use `CHECKLY_CLI_VERSION` environment variable to set the latest version you want to test.
+
 To get started with local development check [CONTRIBUTING.MD](https://github.com/checkly/checkly-cli/blob/main/CONTRIBUTING.md)

package.json

@@ -1,7 +1,7 @@
 {
  "name": "@checkly/cli-monorepo",
  "private": true,
- "version": "0.0.0",
+ "version": "0.0.1",
  "scripts": {
  "lint": "eslint . --ext .ts,.js,.mjs",
  "lint:fix": "eslint . --ext .ts,.js,.mjs --fix",

packages/cli/package.json

@@ -1,6 +1,6 @@
 {
  "name": "checkly",
- "version": "4.0.9",
+ "version": "0.0.1-dev",
  "description": "Checkly CLI",
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
@@ -18,7 +18,6 @@
  "test": "jest --selectProjects unit",
  "test:e2e": "npm run prepare && cross-env NODE_CONFIG_DIR=./e2e/config jest --selectProjects E2E",
  "test:e2e:local": "cross-env CHECKLY_ENV=local npm run test:e2e",
- "version": "node -e \"console.log(require('./package.json').version)\"",
  "watch": "tsc --watch"
  },
  "repository": {

packages/create-cli/package.json

@@ -1,6 +1,6 @@
 {
  "name": "create-checkly",
- "version": "0.0.4",
+ "version": "0.0.1-dev",
  "description": "Checkly Create CLI",
  "type": "module",
  "main": "dist/index.js",

packages/create-cli/src/commands/bootstrap.ts

@@ -2,7 +2,6 @@ import { Command, Flags } from '@oclif/core'
 import prompts from 'prompts'
 import {
  getUserGreeting,
- getVersion,
  header,
  bail,
  footer,
@@ -47,7 +46,8 @@ export default class Bootstrap extends Command {
  prompts.override({ template })
  }
 
- const [version, greeting] = await Promise.all([getVersion(), getUserGreeting()])
+ const version = process.env.CHECKLY_CLI_VERSION ?? this.config.version
+ const greeting = await getUserGreeting()
 
  await header(version, greeting)
 

packages/create-cli/src/utils/messages.ts

@@ -8,11 +8,6 @@ function sleep (ms: number): Promise<void> {
  return new Promise(resolve => setTimeout(resolve, ms))
 }
 
-export async function getVersion (): Promise<string> {
- const { data } = await axios.get('https://registry.npmjs.org/checkly/latest')
- return data.version
-}
-
 export async function getUserGreeting (): Promise<string> {
  const name = await fullName()
  return name ? `Hi ${name}!` : 'Hi there!'