Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
24 lines (16 loc) · 964 Bytes

DEVELOPMENT.md

File metadata and controls

24 lines (16 loc) · 964 Bytes
Raw

Development

Local development setup

cd /path/to/nodebb
npm link /path/to/nodebb-plugin-internalnotes
./nodebb build
./nodebb dev

Standards and linting

Publishing to npm

A GitHub Action (.github/workflows/publish-npm.yml) runs lint and publishes to npm when:

  • A release is published on GitHub, or
  • The workflow is run manually (Actions → Lint and publish to npm → Run workflow).

One-time setup: In this repo, go to Settings → Secrets and variables → Actions and add a secret named NPM_TOKEN with an npm access token (Automation type is recommended). The workflow will only publish if npm run lint passes.