Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ivojawer committed Mar 5, 2023
1 parent aab71d7 commit a152475
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/cd.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions

name: Wollok-ts-cli CI
name: Release CLI

on:
push:
Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,4 +105,10 @@ npm run pack
And checking the `/dist` folder.
### Releasing
To create a release you must simply create a tag on the repo,this will trigger a pipeline which will create a drafted release with the corresponding binaries **unless another release already exists**.
To create a release follow this steps
1. Create a drafted release.
2. Tag the commit you wish to release.
This will trigger a pipeline which will upload the binaries to the drafted release.
The _package.json_ version and _tag_ **must match**, otherwise the upload will be skipped. Taken from the [electron-build docs](https://www.electron.build/configuration/publish.html#recommended-github-releases-workflow)

0 comments on commit a152475

Please sign in to comment.