Skip to content

Latest commit

 

History

History
29 lines (21 loc) · 1.43 KB

README_INTERNAL.md

File metadata and controls

29 lines (21 loc) · 1.43 KB

Setting up your dev environment

Start by installing the (dev) dependencies—

% yarn install

Initialize Husky to get the pre-commit hook binary installed on your local development workstation—

% yarn prepare

When testing your builds with Strapi, it is best to compile the Typescript and use the JavaScript output in the ./dist directory as your candidate (this is ultimately what is published to NPM). Generating a build can be done by running the following command—

% yarn build

Releasing

  1. Merge feature branches, bug fixes, and whatever changes into master after CI passes and PRs are approved
  2. Create a new branch off master when you're ready to release a new version
  3. On this branch run npm version [...] (see npm-version docs for more info) which will bump the version in package.json and make a tag (for example npm version patch -m "Bump for 3.1.2"). Follow SemVer rules for patch/minor/major.
  4. Push the version commit and the tag git push && git push --tags origin
  5. Open Pull Request, "Rebase and merge" after approved
  6. Create a new release in the Github UI, give the release a name and add release notes (creating the release will kick off npm publish using Github Actions)
  7. Checkout the master branch and pull the latest by running git checkout master && git pull