Skip to content

Commit ea98e26

Browse files
authored
Add CI publish step (#30)
* Add prepare step * Add changelog entry * Clean & build before release * Finalise
1 parent f3bd462 commit ea98e26

File tree

3 files changed

+61
-0
lines changed

3 files changed

+61
-0
lines changed

.github/workflows/publish.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Publish NPM Package
2+
3+
on:
4+
release:
5+
types:
6+
- published
7+
workflow_dispatch:
8+
9+
jobs:
10+
release:
11+
name: Release
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Checkout
15+
uses: actions/checkout@v3
16+
17+
- name: Setup
18+
uses: ./.github/actions/setup
19+
20+
- name: Prepare release
21+
run: |
22+
yarn module clean
23+
yarn module build
24+
cd modules/@shopify/checkout-sheet-kit
25+
npm publish --access public
26+
env:
27+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Changelog
2+
3+
## 0.1.0 - January 15, 2024
4+
5+
Initial publication of the `@shopify/checkout-sheet-kit` package.
6+
7+
Please refer to the [Readme](./README.md) for setup intstructions and usage.
8+
9+
---
10+
11+
Note: breaking changes may be made during Dev Preview with minor version
12+
increments, but will receive a major version increments after release for
13+
General Availability.

docs/contributing/release.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Release
2+
3+
The `@shopify/checkout-sheet-kit` module is published to the NPM package
4+
registry with public access.
5+
6+
In order to publish a new version of the package, you must complete the
7+
following steps:
8+
9+
1. Bump the version in `modules/@shopify/checkout-sheet-kit/package.json` to an
10+
appropriate value.
11+
2. Add a [Changelog](./CHANGELOG.md) entry.
12+
3. Merge your PR to `main`.
13+
4. Create a [Release](/releases) for your new version.
14+
15+
Creating and publishing a Github release with begin the automated process of
16+
publishing the latest version of the package to NPM. It will clean the module
17+
folder, build a new version, run `npm pack --dry-run` to verify the contents and
18+
publish to the NPM registry.
19+
20+
You can follow the release action process via
21+
https://github.com/Shopify/checkout-sheet-kit-react-native/actions/workflows/publish.yml.

0 commit comments

Comments
 (0)