From 723f1df951d0ba7514961c826bd8e32fe40c4b26 Mon Sep 17 00:00:00 2001 From: Antoine <27826950+Antoine-lb@users.noreply.github.com> Date: Tue, 24 Sep 2024 15:28:01 -0300 Subject: [PATCH] Update README.md --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index c75f60cb..7f4334aa 100644 --- a/README.md +++ b/README.md @@ -66,3 +66,16 @@ Builds are automatically published to Github Releases when a tag is created in G [![Star History Chart](https://api.star-history.com/svg?repos=OneFolderApp/OneFolder&type=Date)](https://star-history.com/#OneFolderApp/OneFolder&Date) + + +### Releasing + +When you want to create a new release, follow these steps: + +1. Update the version in your project's `package.json` file (e.g. `1.2.3`) +2. Commit that change (`git commit -am v1.2.3`) +3. Tag your commit (`git tag v1.2.3`). Make sure your tag name's format is `v*.*.*`. Your workflow will use this tag to detect when to create a release +4. Push your changes to GitHub (`git push && git push --tags`) + +After building successfully, the action will publish your release artifacts. By default, a new release draft will be created on GitHub with download links for your app. If you want to change this behavior, have a look at the [`electron-builder` docs](https://www.electron.build). +