Skip to content

Latest commit

 

History

History
27 lines (16 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

27 lines (16 loc) · 1.13 KB
Raw

Development guide

Trying it out locally

Example

tmp=$(mktemp -d) && touch "$tmp"/{path,env}
export RUNNER_TEMP="$tmp" GITHUB_PATH="$tmp/path" GITHUB_ENV="$tmp/env"
env PATH="$(pwd)/.tools:$PATH" INPUT_CRYSTAL=nightly INPUT_SHARDS=true INPUT_TOKEN="$personal_access_token" INSTALL_CRYSTAL_PLATFORM=win32 node index.js

Pre-commit

Make sure that npm test passes. A pre-commit hook is available: git config core.hooksPath .tools/hooks.

CI

Continuous testing runs on GitHub Actions. Make sure that .github/workflows/main.yml and release.yml stay in sync, other than the differences that they already have.

Cutting a release

Switch to master branch, in a clean state. Run .tools/release.sh x.y.z (an actual next version number). You will be switched to the v1 branch, node_modules will be populated, and a tag will be created. The final command to push all this will be only printed. Run it. After this, a release also needs to be published on GitHub Marketplace.

node_modules

The node_modules directory must not be present in the master branch. package-lock.json will be present, though.