release a version

Release a version

This page describes how to release a new version of CPU-X.

CPU-X versioning is following Semantic Versioning Specification (SemVer). There is not really an API (excepted a command line interface), so MAJOR is bumped only if there are big changes.

Assuming a bump from vX.X.X to vX.X.Y, do following steps:

1. Open the CMakeLists.txt at the root directory, then update VERSION in project():

project(cpu-x
	VERSION "X.X.Y"
	LANGUAGES C CXX
)

2. Add <release> in data/io.github.thetumultuousunicornofdarkness.cpu-x.appdata.xml file.

3. Update ChangeLog.md by adding a new section:

---

## [vX.X.Y] - 20XX-XX-XX

### Added

- 

### Changed

- 

### Deprecated

- 

### Removed

- 

### Fixed

- 

### Security

-

Then, fill these sections. You can list all commits since last version by using a command like that:

git switch master
git log --graph --decorate --oneline --color --first-parent master $(git describe --tags --abbrev=0) | grep -Ev "Regen POT file|Update translation files|Translated using Weblate|Added translation using Weblate" | less

Refer to Keep a Changelog for Types of changes. Once done, remove empty sections.

4. Commit and push changes:

echo -n "Enter version: " ; read VERSION
git commit -am "Release version $VERSION"
git tag v$VERSION
git push --atomic origin master v$VERSION

5. Wait until AppImage Versioned workflow exit with success. Then, go to Releases and edit the Draft.
   Fill release notes and publish the release.

6. Update AUR packages:

• cpu-x-opencl

7. Update Flatpak on Flathub.