You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Before building or tagging a new release, ensure that `releases.xml` is up-to-date:
182
+
### Release Workflow
184
183
185
-
1. Create and push a new git tag for the release (e.g., `v1.4.3`)
186
-
2. Generate the `releases.xml` file by running:
187
-
```
188
-
./scripts/generate-releases.sh
189
-
```
190
-
3. If you already have a releases.xml then skip step 2 and directly edit the file in step 3, adding the new version to the top of the file
191
-
3. Edit the generated `releases.xml` with release information if needed
192
-
4. Commit the updated `releases.xml` file to the repository
184
+
The release process involves updating the version, packaging for different distributions, and then tagging/pushing.
193
185
194
-
The build system will fail if:
195
-
-`releases.xml` does not exist
196
-
- The latest version in `releases.xml` does not match the version in `version.txt`
186
+
1.**Update Version & Changelog**:
187
+
* Update `version.txt` with the new version number.
188
+
* Update `releases.xml` using the script:
189
+
```bash
190
+
./scripts/generate-releases.sh
191
+
```
192
+
***Commit these changes** to the main repository. This is critical because the Flatpak build step uses the commit hash of `version.txt`.
197
193
198
-
### Note for AUR publishers
194
+
2. **Run Packaging Scripts**:
195
+
Run the packaging make targets. These will update the submodules (`flathub`, `arch`) with the new version and commit hash.
196
+
* For Arch: `make package-arch`
197
+
* For Flatpak: `make package-flatpak-flathub` (See detailed sections below)
198
+
199
+
3. **Commit Submodule Changes (Local)**:
200
+
Go into the submodules (`arch/` and `flathub/`) and commit the generated changes locally. **Do not push them yet.**
201
+
202
+
4. **Update Main Repo Submodule Pointers**:
203
+
Go back to the root of the `Luminance` repository. You will see that `arch` and `flathub` folders are modified. Commit these changes to the main repository.
204
+
205
+
5. **Tag and Push Main Repo**:
206
+
* Create a git tag for the new version (e.g., `v1.4.4`).
207
+
* Push the commits and the tag to GitHub.
208
+
```bash
209
+
git tag v1.4.4
210
+
git push origin main --tags
211
+
```
212
+
213
+
6. **Push Submodules**:
214
+
Now that the tag exists on GitHub, you can safely push the submodule changes.
215
+
* Push `arch` to AUR.
216
+
* Push `flathub` to the Flathub repository.
217
+
218
+
## Note for AUR publishers
199
219
200
220
Switch the arch submodule push url to the ssh url before pushing to AUR for the first time:
0 commit comments