diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 868cd27c1..5b4d3c5e9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -75,12 +75,11 @@ node test/benchmark/dev.bench.js --save Which will update the build and dev benchmarks. - # Releasing Astro _Note: Only priviledged contributors (L3+) can release new versions of Astro._ -The repo is set up with automatic releases, using the changeset GitHub action & bot. +The repo is set up with automatic releases, using the changeset GitHub action & bot. To release a new version of Astro, find the `Version Packages` PR, read it over, and merge it. @@ -103,16 +102,14 @@ yarn release --tag next--XXX Full documentation: https://github.com/atlassian/changesets/blob/main/docs/snapshot-releases.md - - ## Releasing in "next"/"pre" mode Sometimes, the repo enters "next" mode, which means that `main` is no longer releasing to `npm install astro` but is instead releasing to `npm install astro@next`. We do this from time-to-time to test large features before sharing them with the larger Astro audience. When in "next" mode, the automatic PR release process is for `next`. That means that releasing to `latest` becomes a manual process. To release latest manually while in "next" mode: -1. *In the code snippets below, replace `0.X` with your version (ex: `0.18`, `release/0.18`, etc.).* -1. Create a new `release/0.X` branch, if none exists. +1. _In the code snippets below, replace `0.X` with your version (ex: `0.18`, `release/0.18`, etc.)._ +1. Create a new `release/0.X` branch, if none exists. 1. Point `release/0.X` to the latest commit for the `v0.X` version. 1. `git cherry-pick` commits from `main`, as needed. 1. Make sure that all changesets for the new release are included. You can create some manually (via `yarn changeset`) if needed. @@ -123,7 +120,6 @@ When in "next" mode, the automatic PR release process is for `next`. That means 1. Go to https://github.com/snowpackjs/astro/releases/new and create a new release. Copy the new changelog entry from https://github.com/snowpackjs/astro/blob/latest/packages/astro/CHANGELOG.md. 1. Post in Discord #announcements channel, if needed! - # Translations Help us translate [docs.astro.build](https://docs.astro.build/) into as many languages as possible! This can be a great way to get involved with open source development without having to code.