Skip to content

Latest commit

 

History

History
121 lines (78 loc) · 4.95 KB

CONTRIBUTING.md

File metadata and controls

121 lines (78 loc) · 4.95 KB
Raw

checkly-cli

Dependencies

You will need to install the project's npm dependencies:

npm install # this will install dependencies for both packages (cli and create-cli)

Creating CLI project locally

To run a build with TS for type checking, run:

npm run prepare --workspace packages/create-cli

When running commands from the packages/create-cli directory, the --workspace packages/create-cli flag isn't necessary.

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:

export CHECKLY_ACCOUNT_ID=<YOUR_LOCAL_BACKEND_ACCOUNTID>
export CHECKLY_API_KEY=<YOUR_LOCAL_BACKEND_API_KEY>
export CHECKLY_ENV=local
npm run watch --workspace packages/cli

Running E2E test locally

To run the E2E tests pointing to your local backend use the npm run test:e2e:local --workspace packages/cli

Remember that the --workspace packages/cli flag isn't necessary when running commands from the packages/cli directory.

Running from source in another project

You can use any branch of the code and npm link it so you can use the latest version in any other repo / project as if you are using the installed NPM package

  1. Go to the packages ./packages/cli and ./packages/create-cli directories and run npm link
  2. Go to your other project and run npm link checkly and npm link create-checkly

Make sure you are on the same NodeJS version if you are using nvm or fnm

Running from source in a local folder

You can use the current branch of the code against any examples in the /examples directory for developing and debugging.

  1. Go the ~/your_local_path directory.
  2. Run npm create checkly -- --template boilerplate-project
  3. Just use npx checkly as normal.

Prerelease experimental version

To publish a NPM package for testing purpose, you can tag the pull-request with the build label. A GitHub Action will be triggered and a new experimental version can be installed by executing:

npm install [email protected].<PR-NUMBER>.<COMMIT_SHORT_SHA>

Releasing

Releasing checkly packages

Both packages checkly and create-cli are built and published by the corresponding GitHub action here.

To release packages to NPM:

  1. Publish a Github Release with a valid tag #.#.# and click the Generate release notes button to auto-generate notes following format defined here
  2. When release is published the Github action is triggered. It builds and publishes #.#.#-prerelease prereleases (for both packages).
  3. Test the prerelease version to make sure that it's working.
    • To test npm create checkly, run CHECKLY_CLI_VERSION=4.6.2 npm create [email protected] (substituting 4.6.2 and 4.6.2-prerelease for your versions). CHECKLY_CLI_VERSION is needed since the create-checkly package looks up the corresponding tag on GitHub to pull project templates.
  4. A production deployment will be waiting for approval. After it's approved, the #.#.# version will be published and set as latest

Catching issues in prerelease

If you notice an issue when testing the prerelease you can still roll everything back. Simply delete the GitHub release, and delete the corresponding tags from the GitHub UI (both #.#.# and v#.#.#).

After resolving the issues, you can create another Github release and go through the process again.

Style Guide

Enums vs. Union Types

In general, prefer to use Union Types rather than Enums.

Rather than:

enum BodyType {
  JSON = 'JSON',
  FORM = 'FORM',
  RAW = 'RAW',
}

use:

type BodyType = 'JSON' | 'FORM' | 'RAW'

This is especially important in public facing code (the constructs directory). The main goal is consistency for users. This rule is enforced by ESLint.

If an enum makes sense for a particular use case (internal code), you can explicitly disable the ESLint rule by adding:

// eslint-disable-next-line no-restricted-syntax

ESLint rules and commit messages

Projects are configured to check code linting for staged files before each commit. Also, the commit message must follow config conventions. After running npm run prepare and install the git hooks, before each commit the lint-staged and commitlint will check if everything is fine.

If you have a work-in-progress commit, you can bypass the checks using the --no-verify flag, for example: git commit -m "WIP commit" --no-verify.