-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Use pnpm workspaces and `9.4.0` * Fix changesets release, publish, tag * Temporarily add PR branch to test release process * Remove eager prerelease config * Remove version constraint (should use `package.json` value) * Remove builds from PR branch * Create CONTRIBUTING.md * Ensure `.changeset` is at the root * Remove package-level `release` * Remove all `workflow`-specific commands in release * Remove PR branch from release workflow
- Loading branch information
1 parent
cfc39a4
commit f7e0386
Showing
8 changed files
with
5,330 additions
and
5,503 deletions.
There are no files selected for viewing
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Contributing | ||
|
||
## Releasing | ||
|
||
To release to production, we use | ||
[Changesets](https://github.com/changesets/changesets). This means that | ||
releasing and changelog generation is all managed through PRs, where a bot will | ||
guide you through the process of adding release notes to PRs. | ||
|
||
When you create a PR, the <kbd>changeset-bot</kbd> will add a comment prompting you | ||
to add changesets if this PR requires it. | ||
|
||
![image](https://github.com/user-attachments/assets/91a980f0-d4af-4bad-bb29-732e2be5ff87) | ||
|
||
Clicking the bottom link will take you to the creation of a new changeset on GitHub. It'll look something like this: | ||
|
||
``` | ||
--- | ||
"@inngest/workflow-kit": patch | ||
--- | ||
An important change | ||
``` | ||
|
||
Here we're stating that this PR will change the patch version with the release note `An important change`. | ||
|
||
Each changeset you create will constitute a single user-facing note in | ||
the changelog and GitHub Release notes, so think about how best to introduce a | ||
user to a new feature, fix, or migration when adding a changeset to a PR. | ||
|
||
> [!NOTE] | ||
> Not all changes need a changeset! Since changesets are focused on releases and | ||
> changelogs, changes to a package that don't require these won't need a | ||
> changeset. For example, changing GitHub configuration files or non-user-facing | ||
> markdown. | ||
As PRs are merged into main, a new PR (usually called **Release @latest**) is | ||
created that rolls up all release notes since the last release, allowing you | ||
bundle changes together. Once you're happy with the release, merge this new PR | ||
and the bot will release the package to npm for you and tag the release commit | ||
(which changes version numbers and modifies the changelog) with a tag like | ||
`@inngest/[email protected]`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.