Skip to content

Commit 8c69dc4

Browse files
Copilotsensslen
andcommitted
Add release documentation to README
Co-authored-by: sensslen <3428860+sensslen@users.noreply.github.com>
1 parent c547a58 commit 8c69dc4

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,31 @@ To deploy this application, you first need to build the static assets.
5454
5555
Once you have your web server set up, configure it to serve the files from the `dist` directory.
5656
57+
## Releases
58+
59+
This project uses automated releases via GitHub Actions. When a new version tag is pushed to the repository, the build pipeline automatically:
60+
61+
1. Builds the application
62+
2. Creates a release archive containing all static files
63+
3. Creates a GitHub Release with the version number
64+
4. Uploads the build artifacts to the release
65+
66+
### Creating a New Release
67+
68+
To create a new release, maintainers should:
69+
70+
1. Update the version number in `package.json` if needed
71+
2. Create and push a version tag:
72+
```bash
73+
git tag v1.0.0
74+
git push origin v1.0.0
75+
```
76+
3. The GitHub Actions workflow will automatically build and create the release
77+
78+
### Downloading Releases
79+
80+
Users can download pre-built releases from the [Releases page](https://github.com/sensslen/Cgf.ProPresenter.NurseryMessages/releases). Each release includes a ZIP file with all necessary files to deploy the application.
81+
5782
## License
5883
5984
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)