Skip to content

Commit

Permalink
Merge branch 'master' into feature/component-data-table
Browse files Browse the repository at this point in the history
  • Loading branch information
Imad A. Bakir committed Dec 5, 2024
2 parents 01e4a9d + 49e6aa5 commit 4481df6
Show file tree
Hide file tree
Showing 6 changed files with 974 additions and 1,276 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/publish_npm.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Publish to npm
on:
release:
types: [published] # Run this whenever we create a new release through GitHub releases
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: read
id-token: write
steps:
- uses: actions/checkout@v4
# Setup .npmrc file to publish to npm
- uses: actions/setup-node@v4
with:
node-version: '22.x'
registry-url: 'https://registry.npmjs.org'
- run: npm run ci-project
- run: npm run build --if-present
- run: npm test
- run: npm publish --provenance --access public
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@

# 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:

- Create a release branch named `release/vx.y.z`.

- Submit a release PR targeting the `master` branch:
- Bump the version in `package.json.js`.
- Run `npm run install-project` to update the `package.json` and `package-lock.json` files.
- The commit message should be of the form "Release vx.y.z"
- The title of the release PR should be of the form "Release vx.y.z"

- Once the PR is merged, create a new release:
- Go the GitHub repo, and navigate to ["Releases"](https://github.com/fortanix/baklava/releases).
- Click ["Draft a new release"](https://github.com/fortanix/baklava/releases/new).
- 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.
Loading

0 comments on commit 4481df6

Please sign in to comment.