Compare commits
14 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 69e20c89ee | |||
| 549025dfe7 | |||
| fface10081 | |||
| 2c32f5856b | |||
| 1babd404f9 | |||
| ce35617bbe | |||
| f4c54837de | |||
| 483ef2fecf | |||
| ce236bc49f | |||
| b067cf572e | |||
| af95742f69 | |||
| 0b0f0af82d | |||
| a582913269 | |||
| 911aaca355 |
@@ -10,8 +10,38 @@ permissions:
|
||||
contents: write
|
||||
|
||||
jobs:
|
||||
linux-amd64:
|
||||
verify:
|
||||
runs-on: [self-hosted, linux, arch, homelab]
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Check formatting
|
||||
shell: bash
|
||||
run: cargo fmt --check
|
||||
|
||||
- name: Run tests
|
||||
shell: bash
|
||||
run: cargo test --locked
|
||||
|
||||
- name: Run clippy
|
||||
shell: bash
|
||||
run: cargo clippy --locked -- -D warnings
|
||||
|
||||
- name: Lint YAML
|
||||
shell: bash
|
||||
run: |
|
||||
docker run --rm \
|
||||
-v "$PWD:/work" \
|
||||
-w /work \
|
||||
cytopia/yamllint:latest \
|
||||
-c .yamllint .
|
||||
|
||||
linux-amd64:
|
||||
needs: verify
|
||||
runs-on: [self-hosted, linux, arch, homelab]
|
||||
env:
|
||||
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
@@ -26,9 +56,10 @@ jobs:
|
||||
tag="${GITHUB_REF##*/}"
|
||||
version="${tag#v}"
|
||||
mkdir -p dist
|
||||
cp target/release/gosleep-timer dist/gosleep-timer
|
||||
tar -C dist -czf "dist/gosleep-timer-${version}-linux-amd64.tar.gz" gosleep-timer
|
||||
sha256sum "dist/gosleep-timer-${version}-linux-amd64.tar.gz" > "dist/gosleep-timer-${version}-linux-amd64.tar.gz.sha256"
|
||||
binary="gosleep-timer-${version}-linux-amd64"
|
||||
cp target/release/gosleep-timer "dist/${binary}"
|
||||
cd dist
|
||||
sha256sum "${binary}" > "${binary}.sha256"
|
||||
|
||||
- name: Create Gitea release
|
||||
id: release
|
||||
@@ -70,7 +101,7 @@ jobs:
|
||||
run: |
|
||||
release_url="https://gitea.forust.xyz/api/v1/repos/forust/gosleep/releases"
|
||||
release_id="${{ steps.release.outputs.release_id }}"
|
||||
for asset in dist/*.tar.gz dist/*.sha256; do
|
||||
for asset in dist/gosleep-timer-*; do
|
||||
name="$(basename "$asset")"
|
||||
release="$(curl -fsS \
|
||||
"${release_url}/${release_id}" \
|
||||
|
||||
@@ -46,10 +46,12 @@ Use a temporary config path so local tests do not mutate the user's real config:
|
||||
```bash
|
||||
tmpdir="$(mktemp -d)"
|
||||
cargo run -- --config "$tmpdir/config.yaml" init
|
||||
cargo run -- --config "$tmpdir/config.yaml" validate
|
||||
cargo run -- --config "$tmpdir/config.yaml" status
|
||||
cargo run -- --config "$tmpdir/config.yaml" preview
|
||||
```
|
||||
|
||||
For `run` smoke tests, disable actions first so the command does not call `playerctl`, `systemctl`, `pkill`, workspace tools, or custom shell commands.
|
||||
For `run` smoke tests, pass `--no-actions` or disable actions first so the command does not call `playerctl`, `systemctl`, `pkill`, workspace tools, or custom shell commands.
|
||||
|
||||
## Versioning
|
||||
|
||||
@@ -73,20 +75,21 @@ test "$(cat VERSION)" = "$(cargo metadata --no-deps --format-version 1 | jq -r '
|
||||
Release workflow is tag-based:
|
||||
|
||||
```bash
|
||||
git tag -a v1.1.1 -m "gosleep-timer v1.1.1"
|
||||
git tag -a vMAJOR.MINOR.PATCH -m "gosleep-timer vMAJOR.MINOR.PATCH"
|
||||
git push origin main
|
||||
git push origin v1.1.1
|
||||
git push origin vMAJOR.MINOR.PATCH
|
||||
```
|
||||
|
||||
The Gitea release workflow:
|
||||
|
||||
- runs formatting, tests, clippy, and YAML lint before building
|
||||
- builds `target/release/gosleep-timer`
|
||||
- creates `gosleep-timer-<version>-linux-amd64.tar.gz`
|
||||
- copies `gosleep-timer-<version>-linux-amd64`
|
||||
- writes a `.sha256`
|
||||
- creates or reuses the matching Gitea release
|
||||
- replaces release assets with matching names
|
||||
|
||||
The workflow uses the built-in `GITEA_TOKEN` and declares `permissions: contents: write`.
|
||||
The workflow exposes `${{ secrets.GITEA_TOKEN }}` as `GITEA_TOKEN` and declares `permissions: contents: write`.
|
||||
|
||||
## Git Remote
|
||||
|
||||
|
||||
@@ -4,6 +4,41 @@ All notable changes to this project are documented here.
|
||||
|
||||
The project uses semantic versioning. Tags are formatted as `vMAJOR.MINOR.PATCH`.
|
||||
|
||||
## [1.2.2] - 2026-07-05
|
||||
|
||||
### Changed
|
||||
|
||||
- Updated Ratatui to 0.30.2 to remove the unmaintained `paste` transitive dependency and pick up the fixed `lru` dependency line.
|
||||
- Replaced deprecated `serde_yaml`/`unsafe-libyaml` with the pure-Rust `noyalib` YAML parser.
|
||||
|
||||
## [1.2.1] - 2026-07-05
|
||||
|
||||
### Changed
|
||||
|
||||
- Updated the TUI running screen to center a larger termdown-style ASCII time-left display above progress and post-countdown commands.
|
||||
|
||||
## [1.2.0] - 2026-07-05
|
||||
|
||||
### Added
|
||||
|
||||
- Added `status`, `validate`, `edit`, `history`, and `stats` CLI commands.
|
||||
- Added `run --dry-run` and `run --no-actions` for safer timer verification.
|
||||
- Added TUI pause/resume support and a fullscreen running timer view with large ASCII time-left display.
|
||||
- Added history recording for completed sessions and aggregate sleep/timer statistics.
|
||||
- Added red highlighting for dangerous post-timer actions and common destructive custom commands.
|
||||
|
||||
### Changed
|
||||
|
||||
- TUI settings now hide dependent options when their parent action is disabled.
|
||||
- Release assets are published as a raw Linux binary plus `.sha256` instead of a tar archive.
|
||||
|
||||
## [1.1.3] - 2026-07-03
|
||||
|
||||
### Fixed
|
||||
|
||||
- Made the tag-based release workflow fail closed: lint and test gates now run before build and publish.
|
||||
- Exposed Gitea Actions' built-in `${{ secrets.GITEA_TOKEN }}` to the release API steps so release creation and asset upload authenticate correctly.
|
||||
|
||||
## [1.1.2] - 2026-07-03
|
||||
|
||||
### Fixed
|
||||
@@ -20,5 +55,9 @@ The project uses semantic versioning. Tags are formatted as `vMAJOR.MINOR.PATCH`
|
||||
- Added YAML configuration, CLI `init`, `preview`, and `run` commands.
|
||||
- Added Gitea CI and tag-based release workflows.
|
||||
|
||||
[1.2.2]: https://gitea.forust.xyz/forust/gosleep/releases/tag/v1.2.2
|
||||
[1.2.1]: https://gitea.forust.xyz/forust/gosleep/releases/tag/v1.2.1
|
||||
[1.2.0]: https://gitea.forust.xyz/forust/gosleep/releases/tag/v1.2.0
|
||||
[1.1.3]: https://gitea.forust.xyz/forust/gosleep/releases/tag/v1.1.3
|
||||
[1.1.2]: https://gitea.forust.xyz/forust/gosleep/releases/tag/v1.1.2
|
||||
[1.1.1]: https://gitea.forust.xyz/forust/gosleep/releases/tag/v1.1.1
|
||||
|
||||
Generated
+1107
-174
File diff suppressed because it is too large
Load Diff
+4
-4
@@ -1,8 +1,8 @@
|
||||
[package]
|
||||
name = "gosleep-timer"
|
||||
version = "1.1.2"
|
||||
version = "1.2.2"
|
||||
edition = "2024"
|
||||
rust-version = "1.85"
|
||||
rust-version = "1.88"
|
||||
description = "Terminal sleep timer for Linux desktop actions, with YAML config and a Rust TUI"
|
||||
license = "MIT"
|
||||
repository = "https://gitea.forust.xyz/forust/gosleep"
|
||||
@@ -18,9 +18,9 @@ path = "src/main.rs"
|
||||
anyhow = "1.0"
|
||||
clap = { version = "4.5", features = ["derive"] }
|
||||
crossterm = "0.29"
|
||||
ratatui = "0.29"
|
||||
ratatui = "0.30.2"
|
||||
serde = { version = "1.0", features = ["derive"] }
|
||||
serde_yaml = "0.9"
|
||||
noyalib = "0.0.12"
|
||||
|
||||
[profile.release]
|
||||
codegen-units = 1
|
||||
|
||||
@@ -6,8 +6,7 @@ Rust TUI sleep timer for Linux desktop actions.
|
||||
|
||||
## Status
|
||||
|
||||
- Current version: `1.1.1`
|
||||
- Release tags: `vMAJOR.MINOR.PATCH`, for example `v1.1.1`
|
||||
- Release tags: `vMAJOR.MINOR.PATCH`
|
||||
- Primary repository: <https://gitea.forust.xyz/forust/gosleep>
|
||||
- SSH upstream: `ssh://git@gitssh.forust.xyz:2221/forust/gosleep.git`
|
||||
|
||||
@@ -34,11 +33,11 @@ install -Dm755 target/release/gosleep-timer ~/.local/bin/gosleep-timer
|
||||
|
||||
### From release artifact
|
||||
|
||||
Download `gosleep-timer-<version>-linux-amd64.tar.gz` from the Gitea release page, then:
|
||||
Download `gosleep-timer-<version>-linux-amd64` and its `.sha256` from the Gitea release page, then:
|
||||
|
||||
```bash
|
||||
tar -xzf gosleep-timer-1.1.1-linux-amd64.tar.gz
|
||||
install -Dm755 gosleep-timer ~/.local/bin/gosleep-timer
|
||||
sha256sum -c gosleep-timer-<version>-linux-amd64.sha256
|
||||
install -Dm755 gosleep-timer-<version>-linux-amd64 ~/.local/bin/gosleep-timer
|
||||
```
|
||||
|
||||
## Usage
|
||||
@@ -61,6 +60,24 @@ Preview commands that will run after the countdown:
|
||||
gosleep-timer preview
|
||||
```
|
||||
|
||||
Show the current config, enabled actions, and dangerous-action markers:
|
||||
|
||||
```bash
|
||||
gosleep-timer status
|
||||
```
|
||||
|
||||
Validate the config without starting the timer:
|
||||
|
||||
```bash
|
||||
gosleep-timer validate
|
||||
```
|
||||
|
||||
Open the config in `$VISUAL`, `$EDITOR`, or `vi`:
|
||||
|
||||
```bash
|
||||
gosleep-timer edit
|
||||
```
|
||||
|
||||
Run the saved timer config:
|
||||
|
||||
```bash
|
||||
@@ -74,6 +91,20 @@ gosleep-timer run 45m
|
||||
gosleep-timer run 1h30m
|
||||
```
|
||||
|
||||
Run the countdown without executing post-timer actions:
|
||||
|
||||
```bash
|
||||
gosleep-timer run --dry-run 10s
|
||||
gosleep-timer run --no-actions 10s
|
||||
```
|
||||
|
||||
Inspect recorded sessions and aggregate stats:
|
||||
|
||||
```bash
|
||||
gosleep-timer history
|
||||
gosleep-timer stats
|
||||
```
|
||||
|
||||
Use a custom config path:
|
||||
|
||||
```bash
|
||||
@@ -90,6 +121,7 @@ gosleep-timer --config ./config.yaml preview
|
||||
| `Enter` while editing | Apply edit |
|
||||
| `Esc` while editing | Cancel edit |
|
||||
| `r` | Start/restart timer |
|
||||
| `p` | Pause/resume running timer |
|
||||
| `x` | Stop timer |
|
||||
| `s` | Save config |
|
||||
| `q` / `Esc` | Quit |
|
||||
@@ -155,6 +187,12 @@ Other actions use common Linux desktop tools:
|
||||
- `systemctl`
|
||||
|
||||
Install only the tools needed for the actions you enable.
|
||||
Dangerous actions such as `pkill`, power actions, and common destructive custom commands are highlighted in red in the TUI preview.
|
||||
|
||||
## History
|
||||
|
||||
Completed timer sessions are appended to `history.yaml` next to the active config file.
|
||||
If no poweroff or reboot action is configured, CLI `run` asks for wake confirmation after the timer finishes and records the elapsed sleep time.
|
||||
|
||||
## Development
|
||||
|
||||
@@ -185,7 +223,7 @@ Version is stored in:
|
||||
Release tags must match the package version:
|
||||
|
||||
```bash
|
||||
git tag -a v1.1.1 -m "gosleep-timer v1.1.1"
|
||||
git tag -a vMAJOR.MINOR.PATCH -m "gosleep-timer vMAJOR.MINOR.PATCH"
|
||||
git push origin main --tags
|
||||
```
|
||||
|
||||
@@ -198,12 +236,11 @@ Required runner tools:
|
||||
- Rust stable toolchain with `cargo`, `rustfmt`, and `clippy`
|
||||
- `curl`
|
||||
- `jq`
|
||||
- `tar`
|
||||
- `sha256sum`
|
||||
|
||||
Release authentication:
|
||||
|
||||
- The workflow uses Gitea Actions' built-in `GITEA_TOKEN`.
|
||||
- The workflow exposes Gitea Actions' built-in `${{ secrets.GITEA_TOKEN }}` as `GITEA_TOKEN`.
|
||||
- The workflow declares `permissions: contents: write` so the token can create releases and upload assets.
|
||||
|
||||
See [RELEASING.md](RELEASING.md) for the full release checklist.
|
||||
|
||||
+17
-15
@@ -36,18 +36,17 @@ https://gitea.forust.xyz/forust/gosleep.git
|
||||
- `clippy`
|
||||
- `curl`
|
||||
- `jq`
|
||||
- `tar`
|
||||
- `sha256sum`
|
||||
- Docker, if using the YAML lint job as written
|
||||
4. Confirm Actions job token permissions allow `contents: write`.
|
||||
The release workflow uses Gitea Actions' built-in `GITEA_TOKEN`; no extra repository secret is required.
|
||||
The release workflow uses Gitea Actions' built-in `GITEA_TOKEN`, exposed in the workflow as `${{ secrets.GITEA_TOKEN }}`; no extra repository secret is required.
|
||||
|
||||
## Version Bump Checklist
|
||||
|
||||
For a patch bump, for example `1.1.1` to `1.1.2`:
|
||||
For a patch bump, for example `1.1.3` to `1.1.4`:
|
||||
|
||||
```bash
|
||||
version=1.1.2
|
||||
version=1.1.4
|
||||
```
|
||||
|
||||
Update:
|
||||
@@ -70,21 +69,23 @@ cargo build --release --locked
|
||||
|
||||
```bash
|
||||
git status --short
|
||||
git commit -am "chore: release v1.1.2"
|
||||
git tag -a v1.1.2 -m "gosleep-timer v1.1.2"
|
||||
git commit -am "chore: release v${version}"
|
||||
git tag -a "v${version}" -m "gosleep-timer v${version}"
|
||||
git push origin main
|
||||
git push origin v1.1.2
|
||||
git push origin "v${version}"
|
||||
```
|
||||
|
||||
The `.gitea/workflows/release.yaml` workflow will:
|
||||
|
||||
1. Build `target/release/gosleep-timer`.
|
||||
2. Package `gosleep-timer-<version>-linux-amd64.tar.gz`.
|
||||
3. Generate a SHA-256 checksum.
|
||||
4. Create a Gitea release.
|
||||
5. Upload the archive and checksum as release assets.
|
||||
1. Re-run release gates: `cargo fmt --check`, `cargo test --locked`, `cargo clippy --locked -- -D warnings`, and YAML lint.
|
||||
2. Build `target/release/gosleep-timer`.
|
||||
3. Copy binary as `gosleep-timer-<version>-linux-amd64`.
|
||||
4. Generate a SHA-256 checksum.
|
||||
5. Create a Gitea release.
|
||||
6. Upload the binary and checksum as release assets.
|
||||
|
||||
The workflow is idempotent: if the release already exists, it reuses it and replaces assets with matching names.
|
||||
If any lint or test step fails, the build and release job will not run.
|
||||
|
||||
## Manual Asset Build
|
||||
|
||||
@@ -94,7 +95,8 @@ If Actions are unavailable:
|
||||
version="$(cat VERSION)"
|
||||
cargo build --release --locked
|
||||
mkdir -p dist
|
||||
cp target/release/gosleep-timer dist/gosleep-timer
|
||||
tar -C dist -czf "dist/gosleep-timer-${version}-linux-amd64.tar.gz" gosleep-timer
|
||||
sha256sum "dist/gosleep-timer-${version}-linux-amd64.tar.gz" > "dist/gosleep-timer-${version}-linux-amd64.tar.gz.sha256"
|
||||
binary="gosleep-timer-${version}-linux-amd64"
|
||||
cp target/release/gosleep-timer "dist/${binary}"
|
||||
cd dist
|
||||
sha256sum "${binary}" > "${binary}.sha256"
|
||||
```
|
||||
|
||||
+799
-50
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user