Skip to content

Commit a604c61

Browse files
Merge branch 'main' of github.com:storyblok/field-plugin
2 parents 48919ea + 0e8bc83 commit a604c61

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -153,14 +153,15 @@ This will prompt you to select which package (`@storyblok/field-plugin` or `@sto
153153

154154
Once this pull request is reviewed and merged, you'll get a commit like [this](https://github.com/storyblok/field-plugin/commit/b4bd948ce3d26f0905352ddbe474ebc9e2f89159).
155155

156-
Then, go to [Releases](https://github.com/storyblok/field-plugin/releases) and create a new release. The title should follow the format `<PACKAGE-NAME>@<VERSION>`. Examples:
156+
Then, go to [Releases](https://github.com/storyblok/field-plugin/releases) and draft a new release:
157157

158-
- `@storyblok/[email protected]`
159-
- `@storyblok/[email protected]`
158+
- Create a tag with the format `<PACKAGE-NAME>@<VERSION>`; for example, `@storyblok/[email protected]` and `@storyblok/[email protected]`
159+
- Set the title to the same name.
160+
- Generate release notes, and ensure that the content is accurate; for example, check that there are no missing bullet points, and check that library changes should not be listed in CLI release notes.
160161

161-
You can find a sample release [here](https://github.com/storyblok/field-plugin/releases/tag/%40storyblok%2Ffield-plugin-cli%400.0.1-beta.2). Make sure you write accurate changelogs, ensuring that library changes are not included in a CLI release and vice versa.
162+
You can find a sample release [here](https://github.com/storyblok/field-plugin/releases/tag/%40storyblok%2Ffield-plugin-cli%400.0.1-beta.2).
162163

163-
Once a release is created, one of the two GitHub Actions - [.github/workflows/npm-publish-library.yml](https://github.com/storyblok/field-plugin/blob/main/.github/workflows/npm-publish-library.yml) or [.github/workflows/npm-publish-cli.yml](https://github.com/storyblok/field-plugin/blob/main/.github/workflows/npm-publish-cli.yml) - will run and deploy it to NPM.
164+
Once a release is created, one of the two GitHub Actions[.github/workflows/npm-publish-library.yml](https://github.com/storyblok/field-plugin/blob/main/.github/workflows/npm-publish-library.yml) or [.github/workflows/npm-publish-cli.yml](https://github.com/storyblok/field-plugin/blob/main/.github/workflows/npm-publish-cli.yml)will run and deploy the corresponding package to npm.
164165

165166
### Order of releases
166167

0 commit comments

Comments
 (0)