Skip to content

Latest commit

 

History

History
80 lines (55 loc) · 3.48 KB

CONTRIBUTING.md

File metadata and controls

80 lines (55 loc) · 3.48 KB

Contributing

Code of Conduct

Please see ./CODE_OF_CONDUCT.md.

Change requests

Feature branch names should be of the form feature/<issue-ref>-<issue-summary>, where <issue-ref> is a reference to the relevant issue number, if any, and <issue-summary> is a short summary of the issue in camel case. For example: feature/gh-2-add-new-gizmo. If there is no issue number for the change (e.g. it's a quick one-off change), use the format <username>/<date>-<summary>, for example mkrause/241129-upgrade-dependencies.

Release workflow

To create a new release:

  • First, create a release PR:

    • Create a release branch named release/vx.y.z.
    • Bump the version in package.json.js.
    • Run npm run install-project to update the package.json and package-lock.json files.
    • Commit the changes, and push the branch. The commit message should be "Release vx.y.z".
    • Create a new PR targeting the master branch. The title should be "Release vx.y.z".
      • Note: you can run npm run automate github:create-release-pr to generate a link with all the information prefilled.

  • Once the release PR is merged, create a new GitHub release:

    • From the master branch, run npm run automate github:create-release, this will generate a link to create the release with all the information filled in.
    • Or if you want to do it manually:
      • Go the GitHub repo, and navigate to "Releases".
      • Click "Draft a new release".
      • Under "Choose a new tag", create a new tag of the form vx.y.z.
      • The name of the release should be of the form vx.y.z.
    • Write the release notes.
    • If the version is a pre-release, mark it as such.
    • Hit "Publish the release".

  • Once the release has been created, a GitHub Actions workflow will automatically run to publish this release to npm.

Script:

VERSION=x.y.z
git co -b release/v${VERSION}
sed -i '' "s/version: '.*'/version: '${VERSION}'/" package.json.js
npm run install-project
git add package.json.js package.json package-lock.json
git ci -m "Release v${VERSION}"
git push -u origin HEAD
npm run automate github:create-release-pr
# Follow instructions from above command

Publishing to npm

To publish to npm:

npm publish --scope=@fortanix --access=public --dry-run # --tag=beta

Set the --tag as appropriate: beta for beta releases, or remove the --tag if you want to publish a stable release. Remove the --dry-run once you’ve confirmed there are no issues.

Note: you rarely need to do this manually. Instead, see the "Release workflow" above, which will trigger an npm publish automatically upon creation of a GitHub release.

FAQ

Q: I'm getting the following error in GitHub Actions CI after changing the package.json, what should I do?

Error: Cannot find module @rollup/rollup-linux-x64-gnu. npm has a bug related to optional dependencies (https://github.com/npm/cli/issues/4828). Please try `npm i` again after removing both package-lock.json and node_modules directory.
  • A: This happens when your local machine uses a different OS (e.g. Mac). One workaround you can find online is to add said dependency to optionalDependencies. This fixes that particular problem, but you will just continue to get the same errors for other dependencies. Instead, do as the error message suggests and completely remove node_modules and package-lock.json and re-install. This should fix the errors.