Skip to content

Commit 2bc371a

Browse files
Add a Contributing section to the README (#147)
1 parent 8539d92 commit 2bc371a

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -436,3 +436,18 @@ leeway collect components -l someConstant
436436
```bash
437437
LEEWAY_EXPERIMENTAL=true leeway export --strict /some/destination
438438
```
439+
440+
# Contributing
441+
442+
## Creating a new release
443+
444+
Releases of Leeway are created by the [release workflow](.github/workflows/release.yaml) which uses [goreleaser/goreleaser-action](https://github.com/goreleaser/goreleaser-action).
445+
446+
To create a new release create a new Git tag and push it:
447+
448+
```sh
449+
git tag vX.X.X
450+
git push origin vX.X.X
451+
```
452+
453+
This will trigger the workflow which you can find [here](https://github.com/gitpod-io/leeway/actions/workflows/release.yaml). Once it's done a new release will show up in GitHub [here](https://github.com/gitpod-io/leeway/releases).

0 commit comments

Comments
 (0)