Matt Aitken
0558b2c595
* Feat/svelte kit support (#467) * feat: implemented svelte-kit adapter * feat: implemented the @trigger.dev/svelte package * scaffolded a sveltekit example project with trigger.dev * added the convertToStandardRequest function in the sveltekit package * example sveltekit project with the @trigger.dev/svelte package * doc: added the manual setup guide for sveltekit * updated the web app onboard for sveltekit * formatted the manual setup guide for sveltekit * added a link to webapp sveltekit onboarding * added a wait function to the sveltekit example app job * typo fix * removed comments from the @trigger.dev/svelte - commented out the useEventRunDetails * updated package.json to use internal packages * added a .env.example file * updated the example-svelte-app * updated the svelte-example * updated the onboarding page to reflect requested changes * made the manual setup guide more specific * created a .env.example file for svelte-example * added import aliases * updated the tsconfig and svelte.config file * updated to use uint8Array * added missing paths in the tsconfig --------- Co-authored-by: Matt Aitken <matt@mattaitken.com> * Moved examples to references * Tweaked the SveleteKit manual setup guide * Updated zod, and set the svelte/sveltekit package versions to match other packages * Added the headers to the response from the SvelteKit api/trigger route * Changeset for Svelte and SvelteKit packages * Revert change to rawBody * Remove core from changeset packages * Delete svelte .npmrc file * Build svelte package to build, not build/lib * Made the snapshot instructions easier to copy * Delete the svelte package * Latest lockfile * Updated the SvelteKit docs * Attempt to get Svelte to import the package * Updates for port and host options * Updated lockfile from main * Update neat-feet-wait.md --------- Co-authored-by: Chigala <92148630+Chigala@users.noreply.github.com>
58 lines
2.0 KiB
Markdown
58 lines
2.0 KiB
Markdown
# Changesets
|
|
|
|
Trigger.dev uses [changesets](https://github.com/changesets/changesets) to manage updated our packages and releasing them to npm.
|
|
|
|
## Adding a changeset
|
|
|
|
To add a changeset, use `pnpm run changeset:add` and follow the instructions [here](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md). Please only ever select one of our public packages when adding a changeset.
|
|
|
|
## Release instructions (local only)
|
|
|
|
Based on the instructions [here](https://github.com/changesets/changesets/blob/main/docs/intro-to-using-changesets.md)
|
|
|
|
1. Run `pnpm run changeset:version`
|
|
2. Run `pnpm run changeset:release`
|
|
|
|
## Release instructions (CI)
|
|
|
|
Please follow the best-practice of adding changesets in the same commit as the code making the change with `pnpm run changeset:add`, as it will allow our release.yml CI workflow to function properly:
|
|
|
|
- Anytime new changesets are added in a commit in the `main` branch, the [release.yml](./.github/workflows/release.yml) workflow will run and will automatically create/update a PR with a fresh run of `pnpm run changeset:version`.
|
|
- When the version PR is merged into `main`, the release.yml workflow will automatically run `pnpm run changeset:release` to build and release packages to npm.
|
|
|
|
## Pre-release instructions
|
|
|
|
1. Add changesets as usual `pnpm run changeset:add`
|
|
2. Switch to pre-release mode by running `pnpm run changeset:next`
|
|
3. Create version `pnpm run changeset:version`
|
|
4. Release `pnpm run changeset:release`
|
|
5. Switch back to normal mode by running `pnpm run changeset:normal`
|
|
|
|
## Snapshot instructions
|
|
|
|
!MAKE SURE TO UPDATE THE TAG IN THE INSTRUCTIONS BELOW!
|
|
|
|
1. Add changesets as usual
|
|
|
|
```sh
|
|
pnpm run changeset:add
|
|
```
|
|
|
|
2. Create a snapshot version (replace "prerelease" with your tag)
|
|
|
|
```sh
|
|
pnpm exec changeset version --snapshot prerelease
|
|
```
|
|
|
|
3. Build the packages:
|
|
|
|
```sh
|
|
pnpm run build --filter "@trigger.dev/*"
|
|
```
|
|
|
|
4. Publish the snapshot (replace "dev" with your tag)
|
|
|
|
```sh
|
|
pnpm exec changeset publish --no-git-tag --snapshot --tag prerelease
|
|
```
|