diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml index f7e142e..0213c09 100644 --- a/.github/workflows/cd.yml +++ b/.github/workflows/cd.yml @@ -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: diff --git a/README.md b/README.md index 14b5a68..bf24ff0 100644 --- a/README.md +++ b/README.md @@ -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**. \ No newline at end of file +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)