Skip to content

Commit

Permalink
Finalise
Browse files Browse the repository at this point in the history
  • Loading branch information
markmur committed Jan 15, 2024
1 parent 9487d1b commit af987a1
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 9 deletions.
16 changes: 7 additions & 9 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
name: Publish NPM Package

# on:
# release:
# types:
# - published
# workflow_dispatch:
on:
push:
pull_request:
types: [opened, synchronize]
release:
types:
- published
workflow_dispatch:

jobs:
release:
Expand All @@ -26,4 +22,6 @@ jobs:
yarn module clean
yarn module build
cd modules/@shopify/checkout-sheet-kit
npm pack --dry-run
npm publish --access public
env:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
21 changes: 21 additions & 0 deletions docs/contributing/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Release

The `@shopify/checkout-sheet-kit` module is published to the NPM package
registry with public access.

In order to publish a new version of the package, you must complete the
following steps:

1. Bump the version in `modules/@shopify/checkout-sheet-kit/package.json` to an
appropriate value.
2. Add a [Changelog](./CHANGELOG.md) entry.
3. Merge your PR to `main`.
4. Create a [Release](/releases) for your new version.

Creating and publishing a Github release with begin the automated process of
publishing the latest version of the package to NPM. It will clean the module
folder, build a new version, run `npm pack --dry-run` to verify the contents and
publish to the NPM registry.

You can follow the release action process via
https://github.com/Shopify/checkout-sheet-kit-react-native/actions/workflows/publish.yml.

0 comments on commit af987a1

Please sign in to comment.