diff options
| author | xengineering <me@xengineering.eu> | 2024-10-23 16:01:36 +0200 |
|---|---|---|
| committer | xengineering <me@xengineering.eu> | 2024-10-23 16:04:22 +0200 |
| commit | 2195cfce131ee599c71d0c426a7eea70ed52345f (patch) | |
| tree | c2cc44bfbafc2d082dd56514ff6b06066dc1a3cc /RELEASE.md | |
| parent | dbc874e2b9f300bea7a18deda32e784afb0ab89a (diff) | |
| download | ceres-2195cfce131ee599c71d0c426a7eea70ed52345f.tar ceres-2195cfce131ee599c71d0c426a7eea70ed52345f.tar.zst ceres-2195cfce131ee599c71d0c426a7eea70ed52345f.zip | |
Inject version with embed instead of build flags
The build flags made the basic build and debug calls quite complex and
bound this strictly to Git repositories which is a problem if the source
code is passed around as tar archive.
Embedding this via Go's embed package and a VERSION.txt file makes this
way easier. A simple `go build` command is sufficient to build ceres.
To make sure the version string is extended by a `-devel` marker and
that this marker is removed before a release a RELEASE.md file was added
as a checklist for releases.
Diffstat (limited to 'RELEASE.md')
| -rw-r--r-- | RELEASE.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..b403a31 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,8 @@ +# Release checklist + +- remove `-devel` from VERSION.txt +- update CHANGELOG.md +- `go test ./...` must succeed +- release with `git tag -u <user> -m 'Release version <version>' 'v<version>' + with version as <major>.<minor>.<patch> (e.g. 0.2.3) +- remove `-devel` from VERSION.txt |