Skip to content

Commit 3a113f3

Browse files
authored
Document automated releases and version management
Added documentation for automated releases and versioning.
1 parent 7170f04 commit 3a113f3

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,3 +63,37 @@ Open your terminal in the project root and use the following targets:
6363
<td>If the generated .app or .deb won't execute, ensure you have the necessary write permissions in the dist/ directory.</td>
6464
</tr>
6565
</table>
66+
67+
## Automated Releases
68+
This project uses GitHub Actions to automatically build and distribute native installers. The workflow is split into two phases: Build and Release.
69+
70+
### The Build Phase (Continuous Integration)
71+
Every time you push code to the main branch or open a Pull Request:
72+
- GitHub starts a macOS runner and an Ubuntu runner.
73+
- Both systems compile the code and create their respective installers (.dmg and .deb).
74+
- The installers are saved as Artifacts in the GitHub Actions run summary for 90 days.
75+
### The Release Phase (Continuous Deployment)
76+
A formal GitHub Release is only triggered when you push a version tag.
77+
This creates a permanent download page for your users.
78+
79+
#### How to trigger a new release:
80+
To release a new version (e.g., version 1.0.1), run the following commands in your terminal:
81+
82+
```Bash
83+
# 1. Tag the current commit
84+
git tag v1.0.1
85+
86+
# 2. Push the tag to GitHub
87+
git push origin v1.0.1
88+
```
89+
### Downloading the Installers
90+
- Go to the Releases section on the right-hand sidebar of this GitHub repository.
91+
- Find the latest version (e.g., v1.0.1).
92+
- Under Assets, you will find:
93+
- MyAntApp-Installer.dmg (for macOS)
94+
- MyAntApp-Linux.deb (for Ubuntu/Debian)
95+
96+
### Pro-Tip: Changing the Version Number
97+
When you're ready to bump the version, remember to update the version number in two places to keep everything in sync:
98+
- The Git Tag (the v1.0.1 above).
99+
- The app.version property at the top of your build.xml. This ensures that when the user installs the app, the OS sees the correct version number in the "About" or "Get Info" screens.

0 commit comments

Comments
 (0)