v0.1.1: run tests in CI, add REUSE compliance and CONTRIBUTING

- Add .github/workflows/test.yml, using flatpak-builder's run-tests
  option so PRs and pushes exercise ctest inside the same KDE SDK
  sandbox as release builds.
- Add REUSE.toml covering files that can't carry an inline SPDX header
  (.desktop, keys/*.asc).
- Add CONTRIBUTING.md documenting build/test/release steps.
This commit is contained in:
2026-07-03 12:07:30 -05:00
parent 337eb1a6bd
commit 753822c242
6 changed files with 113 additions and 2 deletions
+39
View File
@@ -0,0 +1,39 @@
# SPDX-License-Identifier: GPL-3.0-or-later
name: Build and Test
on:
pull_request: {}
push:
branches:
- main
jobs:
test:
name: Build and run tests
runs-on: ubuntu-latest
container:
# Ships the KDE Platform/Sdk + flatpak-builder. Bump the tag to match
# runtime-version in the manifest.
image: ghcr.io/flathub-infra/flatpak-github-actions:kde-6.10
options: --privileged
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Build from the checked-out commit
run: |
python3 - <<'PY'
import re
p = "io.github.toservetheking.Kareer.yml"
s = open(p).read()
s = re.sub(r" sources:.*\Z",
" sources:\n - type: dir\n path: .\n",
s, flags=re.S)
open(p, "w").write(s)
print(s)
PY
- name: Build and run tests
run: |
flatpak-builder --user --disable-rofiles-fuse --force-clean \
builddir io.github.toservetheking.Kareer.yml
+1 -1
View File
@@ -3,7 +3,7 @@
cmake_minimum_required(VERSION 3.16)
project(kareer VERSION 0.1.0 LANGUAGES CXX)
project(kareer VERSION 0.1.1 LANGUAGES CXX)
set(REQUIRED_QT_VERSION 6.6.0)
set(REQUIRED_KF_VERSION 6.5.0)
+50
View File
@@ -0,0 +1,50 @@
# Contributing to Kareer
## Build
Kareer is a KDE/Kirigami application (C++20 + QML) built with CMake and
Extra CMake Modules. See the README for the full list of system packages
to install, then:
```sh
cmake -B build -G Ninja
cmake --build build
./build/bin/kareer
```
Every GUI action is also available from the `kareer` CLI
(`add|list|show|update|stage|delete|stats|stages`) — run `./build/bin/kareer
--help` to see the subcommands.
## Test
```sh
ctest --test-dir build --output-on-failure
```
Tests live in `autotests/` and link the core logic directly out of `src/`
(see `autotests/CMakeLists.txt`). CI runs the same suite on every pull
request via `.github/workflows/test.yml`, using `flatpak-builder`'s
`run-tests` option so the run happens inside the same KDE SDK sandbox as
release builds.
## Conventions
- Every source file starts with `SPDX-License-Identifier: GPL-3.0-or-later`
(in whatever comment syntax fits the file type). Files that can't carry
an inline header — `.desktop`, `keys/*.asc` — are covered instead by
`REUSE.toml`.
- `src/` is intentionally flat: one class per concern, no `models/`,
`controllers/`, or `viewmodels/` subfolders.
- C++ backend classes are exposed to QML via `QML_ELEMENT`; QML views are
meant to stay thin renderers over that state, not hold logic themselves.
- `JobsDatabase` is the only class that touches the SQLite database
directly — route all persistence changes through it.
## Releasing
`.github/workflows/build.yml` builds, signs, and publishes a Flatpak
bundle whenever a `v*` tag is pushed. To cut a release: bump
`project(... VERSION ...)` in `CMakeLists.txt`, add a matching `<release>`
entry to the metainfo file, update the manifest's pinned `tag:`, then tag
and push.
+12
View File
@@ -0,0 +1,12 @@
version = 1
SPDX-PackageName = "Kareer"
SPDX-PackageSupplier = "ToServeTheKing <[email protected]>"
SPDX-PackageDownloadLocation = "https://github.com/toservetheking/Kareer"
[[annotations]]
path = [
"io.github.toservetheking.Kareer.desktop",
"keys/*.asc",
]
SPDX-License-Identifier = "GPL-3.0-or-later"
SPDX-FileCopyrightText = "ToServeTheKing <[email protected]>"
@@ -64,6 +64,15 @@
<content_rating type="oars-1.1"/>
<releases>
<release version="0.1.1" date="2026-07-03">
<description>
<ul>
<li>Run the test suite in CI on every pull request</li>
<li>Add REUSE license-compliance metadata</li>
<li>Add a CONTRIBUTING guide</li>
</ul>
</description>
</release>
<release version="0.1.0" date="2026-07-03">
<description>
<p>Initial release.</p>
+2 -1
View File
@@ -25,11 +25,12 @@ modules:
buildsystem: cmake-ninja
config-opts:
- -DCMAKE_BUILD_TYPE=Release
run-tests: true
sources:
# For Flathub / release builds, pin to a tag AND commit:
- type: git
url: https://github.com/toservetheking/Kareer.git
tag: v0.1.0
tag: v0.1.1
# commit: <fill in the exact commit SHA the tag points at>
#
# For local testing before the repo is pushed, replace the source above with: