Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
40 lines (26 loc) · 1.96 KB

DEVELOPMENT.md

File metadata and controls

40 lines (26 loc) · 1.96 KB
Raw

For contributers

Before you commit

  • Create your branch from master branch. And your pull requests should head to master branch in general.
  • dist/* is generated during the release workflow and is not committed to the repository.
  • Run npm run lint (oxlint), npm run fmt:check (oxfmt), npm run typecheck, and npm test locally. All run in CI. Use npm run lint:fix to auto-fix lint issues and npm run fmt to format the code.

For repository owners

Release procedure

Releases are published from GitHub Actions via the Release workflow.

  1. Open the Release workflow on the Actions tab.
  2. Click Run workflow and select the version bump (patch / minor / major).
  3. Approve the deployment to the production environment when prompted.

The workflow runs CI, bumps the version, builds the package, then:

  • Publishes to npm using Trusted Publishing (OIDC) and provenance.
  • Pushes the new version tag.
  • Pushes the bumped package.json and package-lock.json back to the master branch.
  • Creates a GitHub Release with auto-generated release notes.

Required setup

npm: Trusted Publishing

Allow OIDC publishing from GitHub Actions on the package access settings:

  • Publisher: GitHub Actions
  • Organization or user: nulab
  • Repository: backlog-js
  • Workflow filename: release.yml
  • Environment name: production

GitHub: production environment

Create a production environment on the Environment settings page. Adding a maintainer to Required reviewers lets you require approval before the publish step runs.