Skip to content

Commit 310543d

Browse files
committed
Move releasing documentation to RELEASING.md
1 parent 62e8c67 commit 310543d

File tree

2 files changed

+44
-45
lines changed

2 files changed

+44
-45
lines changed

README.md

Lines changed: 0 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -31,51 +31,6 @@ pnpm test
3131
pnpm typecheck
3232
```
3333

34-
## Releasing
35-
36-
This project uses [Changesets](https://github.com/changesets/changesets) for version management and publishing.
37-
38-
### Adding a changeset
39-
40-
When you make changes that should be released, run:
41-
42-
```bash
43-
pnpm changeset
44-
```
45-
46-
This will prompt you to:
47-
1. Select the packages that have changed
48-
2. Choose the bump type (major, minor, patch)
49-
3. Write a summary of the changes
50-
51-
Commit the generated changeset file along with your changes.
52-
53-
### Publishing releases
54-
55-
Releases are automated via GitHub Actions using [npm trusted publishing](https://docs.npmjs.com/trusted-publishers/) with OIDC (no npm tokens required):
56-
57-
1. When PRs with changesets are merged to `main`, the action creates/updates a "Version Packages" PR
58-
2. This PR bumps versions and updates changelogs based on the changesets
59-
3. Merging the "Version Packages" PR triggers the publish to npm
60-
61-
### npm trusted publisher setup
62-
63-
Each package must be configured on npmjs.com to trust this repository's workflow:
64-
65-
1. Go to the package settings on npmjs.com (e.g., https://www.npmjs.com/package/@savvycal/appointments-core/access)
66-
2. Under "Publishing access", add a trusted publisher with:
67-
- **Repository owner**: `svycal`
68-
- **Repository name**: `appointments`
69-
- **Workflow filename**: `release.yml`
70-
- **Environment**: (leave blank)
71-
72-
### Manual release (if needed)
73-
74-
```bash
75-
pnpm version # Bump versions and update changelogs
76-
pnpm release # Build and publish to npm
77-
```
78-
7934
## License
8035

8136
MIT

RELEASING.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Releasing
2+
3+
This project uses [Changesets](https://github.com/changesets/changesets) for version management and publishing.
4+
5+
## Adding a changeset
6+
7+
When you make changes that should be released, run:
8+
9+
```bash
10+
pnpm changeset
11+
```
12+
13+
This will prompt you to:
14+
1. Select the packages that have changed
15+
2. Choose the bump type (major, minor, patch)
16+
3. Write a summary of the changes
17+
18+
Commit the generated changeset file along with your changes.
19+
20+
## Publishing releases
21+
22+
Releases are automated via GitHub Actions using [npm trusted publishing](https://docs.npmjs.com/trusted-publishers/) with OIDC (no npm tokens required):
23+
24+
1. When PRs with changesets are merged to `main`, the action creates/updates a "Version Packages" PR
25+
2. This PR bumps versions and updates changelogs based on the changesets
26+
3. Merging the "Version Packages" PR triggers the publish to npm
27+
28+
## npm trusted publisher setup
29+
30+
Each package must be configured on npmjs.com to trust this repository's workflow:
31+
32+
1. Go to the package settings on npmjs.com (e.g., https://www.npmjs.com/package/@savvycal/appointments-core/access)
33+
2. Under "Publishing access", add a trusted publisher with:
34+
- **Repository owner**: `svycal`
35+
- **Repository name**: `appointments`
36+
- **Workflow filename**: `release.yml`
37+
- **Environment**: (leave blank)
38+
39+
## Manual release (if needed)
40+
41+
```bash
42+
pnpm version # Bump versions and update changelogs
43+
pnpm release # Build and publish to npm
44+
```

0 commit comments

Comments
 (0)