Compare commits
11 Commits
67f302c2e9
...
v0.1.0
| Author | SHA1 | Date | |
|---|---|---|---|
| c3a6957a9e | |||
|
10060db8cb
|
|||
| 283a0d3905 | |||
|
1012ca5378
|
|||
|
6e00e89bb0
|
|||
|
403e047c0c
|
|||
|
56fb554f13
|
|||
| 8ed98cc998 | |||
|
f81bb53353
|
|||
|
db1f56c539
|
|||
|
e1cd5dfd35
|
47
.gitea/workflows/upload-assets.yml
Normal file
47
.gitea/workflows/upload-assets.yml
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
# ========================
|
||||||
|
# 📦 Upload Assets Template
|
||||||
|
# ========================
|
||||||
|
# Dieser Workflow wird automatisch ausgelöst, wenn ein Release
|
||||||
|
# in Gitea veröffentlicht wurde (event: release.published).
|
||||||
|
#
|
||||||
|
# Er dient dem Zweck, Release-Artefakte (wie z. B. Binary-Dateien,
|
||||||
|
# Changelogs oder Build-Zips) nachträglich mit dem Release zu verknüpfen.
|
||||||
|
#
|
||||||
|
# Voraussetzung: Zwei Shell-Skripte liegen im Projekt:
|
||||||
|
# - .gitea/scripts/get-release-id.sh → ermittelt Release-ID per Tag
|
||||||
|
# - .gitea/scripts/upload-asset.sh → lädt Datei als Release-Asset hoch
|
||||||
|
#
|
||||||
|
# --------------------------------------
|
||||||
|
|
||||||
|
name: Upload Assets
|
||||||
|
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
types: [published] # Nur bei Veröffentlichung eines Releases (nicht bei Entwürfen)
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
upload-assets:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
# 📥 Checke den Stand des Repos aus, exakt auf dem veröffentlichten Tag
|
||||||
|
# So ist garantiert, dass die Artefakte dem Zustand des Releases entsprechen.
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
ref: ${{ github.event.release.tag_name }} # z. B. "v1.2.3"
|
||||||
|
fetch-depth: 0 # vollständige Git-Historie (für z. B. git-cliff, logs etc.)
|
||||||
|
|
||||||
|
# 🆔 Hole die Release-ID basierend auf dem Tag
|
||||||
|
# Die ID wird als Umgebungsvariable RELEASE_ID über $GITHUB_ENV verfügbar gemacht.
|
||||||
|
- name: Get Release ID from tag
|
||||||
|
run: .gitea/scripts/get-release-id.sh "${{ github.event.release.tag_name }}"
|
||||||
|
|
||||||
|
- uses: denoland/setup-deno@v2
|
||||||
|
with:
|
||||||
|
deno-version: v2.x
|
||||||
|
|
||||||
|
- name: Build application
|
||||||
|
run: deno task build
|
||||||
|
|
||||||
|
- name: Upload CHANGELOG.md as RELEASE-NOTES.md
|
||||||
|
run: .gitea/scripts/upload-asset.sh ./dist/systemd-timer systemd-timer
|
||||||
12
CHANGELOG.md
12
CHANGELOG.md
@@ -2,10 +2,14 @@
|
|||||||
|
|
||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
## [unreleased]
|
## [0.1.0] - 2025-05-21
|
||||||
|
|
||||||
### 🚀 Features
|
### 🚀 Features
|
||||||
|
|
||||||
|
- *(workflows)* Add release asset upload workflow - ([1012ca5](https://git.0xmax42.io/maxp/systemd-timer/commit/1012ca53781c36131a8b7aa43a9134f7b8565599))
|
||||||
|
- *(cli)* Use dynamic version retrieval - ([403e047](https://git.0xmax42.io/maxp/systemd-timer/commit/403e047c0c376229244a5605d5c52eb1699acd4a))
|
||||||
|
- *(utils)* Add version retrieval utility - ([56fb554](https://git.0xmax42.io/maxp/systemd-timer/commit/56fb554f132a53d74b2e9a1a02cc973c5420e73c))
|
||||||
|
- *(generator)* Add systemctl usage instructions - ([f81bb53](https://git.0xmax42.io/maxp/systemd-timer/commit/f81bb533536810fc34656d572369b94ab669a181))
|
||||||
- *(cli)* Add command to generate systemd unit files - ([97dc3fe](https://git.0xmax42.io/maxp/systemd-timer/commit/97dc3fe23acf2c35053aced7b34918bab7778c35))
|
- *(cli)* Add command to generate systemd unit files - ([97dc3fe](https://git.0xmax42.io/maxp/systemd-timer/commit/97dc3fe23acf2c35053aced7b34918bab7778c35))
|
||||||
- *(utils)* Export utility functions for filesystem and naming - ([428e849](https://git.0xmax42.io/maxp/systemd-timer/commit/428e84927f8a9a379fa014ea763dd61115be34d6))
|
- *(utils)* Export utility functions for filesystem and naming - ([428e849](https://git.0xmax42.io/maxp/systemd-timer/commit/428e84927f8a9a379fa014ea763dd61115be34d6))
|
||||||
- *(types)* Add TimerOptions interface for timer configuration - ([ba4b933](https://git.0xmax42.io/maxp/systemd-timer/commit/ba4b933f78c48a52b1c199fe28dc82d7ebabd7fe))
|
- *(types)* Add TimerOptions interface for timer configuration - ([ba4b933](https://git.0xmax42.io/maxp/systemd-timer/commit/ba4b933f78c48a52b1c199fe28dc82d7ebabd7fe))
|
||||||
@@ -16,6 +20,11 @@ All notable changes to this project will be documented in this file.
|
|||||||
|
|
||||||
- *(utils)* Update import path for TimerOptions - ([316f3af](https://git.0xmax42.io/maxp/systemd-timer/commit/316f3af04ef7fe4c08963cfe3ad7780ed3bc262c))
|
- *(utils)* Update import path for TimerOptions - ([316f3af](https://git.0xmax42.io/maxp/systemd-timer/commit/316f3af04ef7fe4c08963cfe3ad7780ed3bc262c))
|
||||||
|
|
||||||
|
### 📚 Documentation
|
||||||
|
|
||||||
|
- Add README for systemd-timer CLI tool - ([db1f56c](https://git.0xmax42.io/maxp/systemd-timer/commit/db1f56c539309b8a02adff114d765c725ac5ff8a))
|
||||||
|
- Add MIT license file - ([e1cd5df](https://git.0xmax42.io/maxp/systemd-timer/commit/e1cd5dfd353c7cd7ca770daae5fc40405e461d1d))
|
||||||
|
|
||||||
### 🧪 Testing
|
### 🧪 Testing
|
||||||
|
|
||||||
- *(generate)* Add unit tests for service and timer generation - ([569b14d](https://git.0xmax42.io/maxp/systemd-timer/commit/569b14d57432589107a0f33e52881b605c5f79f9))
|
- *(generate)* Add unit tests for service and timer generation - ([569b14d](https://git.0xmax42.io/maxp/systemd-timer/commit/569b14d57432589107a0f33e52881b605c5f79f9))
|
||||||
@@ -23,6 +32,7 @@ All notable changes to this project will be documented in this file.
|
|||||||
|
|
||||||
### ⚙️ Miscellaneous Tasks
|
### ⚙️ Miscellaneous Tasks
|
||||||
|
|
||||||
|
- *(tasks)* Include version file in build process - ([6e00e89](https://git.0xmax42.io/maxp/systemd-timer/commit/6e00e89bb086672b9c3276ffeebcb1ded28c836f))
|
||||||
- Add VSCode settings for color customizations and folder listener - ([6608f48](https://git.0xmax42.io/maxp/systemd-timer/commit/6608f488405adefc7993f47a137a824e5de62154))
|
- Add VSCode settings for color customizations and folder listener - ([6608f48](https://git.0xmax42.io/maxp/systemd-timer/commit/6608f488405adefc7993f47a137a824e5de62154))
|
||||||
- *(config)* Add deno configuration and lockfile - ([0b72050](https://git.0xmax42.io/maxp/systemd-timer/commit/0b720500e0fe34db087b3277c38fa6bb07875e80))
|
- *(config)* Add deno configuration and lockfile - ([0b72050](https://git.0xmax42.io/maxp/systemd-timer/commit/0b720500e0fe34db087b3277c38fa6bb07875e80))
|
||||||
- Add automated release workflow and scripts for version management - ([a058e7b](https://git.0xmax42.io/maxp/systemd-timer/commit/a058e7b6838d41a98f3269db9a9d1e31f752121f))
|
- Add automated release workflow and scripts for version management - ([a058e7b](https://git.0xmax42.io/maxp/systemd-timer/commit/a058e7b6838d41a98f3269db9a9d1e31f752121f))
|
||||||
|
|||||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2025 0xMax42
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
89
README.md
Normal file
89
README.md
Normal file
@@ -0,0 +1,89 @@
|
|||||||
|
# systemd-timer
|
||||||
|
|
||||||
|
Ein einfaches CLI-Tool zum schnellen Erzeugen von systemd `.service` und `.timer` Units – als Ersatz oder moderne Ergänzung zu klassischen `cron`-Jobs.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🚀 Features
|
||||||
|
|
||||||
|
- Erzeugt `.service` und `.timer` Dateien per CLI
|
||||||
|
- Unterstützt `--user` Timer (für `~/.config/systemd/user/`)
|
||||||
|
- Optionales Logging (`StandardOutput/StandardError`)
|
||||||
|
- Unterstützt:
|
||||||
|
- `--calendar`
|
||||||
|
- `--exec`
|
||||||
|
- `--after`
|
||||||
|
- `--environment`
|
||||||
|
- `--output`
|
||||||
|
- `--dry-run`
|
||||||
|
- Getestet und typisiert mit Deno + Cliffy
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🛠️ Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://git.0xmax42.io/maxp/systemd-timer.git
|
||||||
|
cd systemd-timer
|
||||||
|
deno task build
|
||||||
|
|
||||||
|
# Binary liegt nun unter ./systemd-timer
|
||||||
|
./systemd-timer --help
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📦 Beispiel
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./systemd-timer create \
|
||||||
|
--exec "/usr/local/bin/backup.sh" \
|
||||||
|
--calendar "Mon..Fri 02:00" \
|
||||||
|
--description "Backup Job" \
|
||||||
|
--user \
|
||||||
|
--logfile "/var/log/backup.log"
|
||||||
|
```
|
||||||
|
|
||||||
|
Erzeugt:
|
||||||
|
- `~/.config/systemd/user/backup.service`
|
||||||
|
- `~/.config/systemd/user/backup.timer`
|
||||||
|
|
||||||
|
Anschließend aktivieren:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
systemctl --user daemon-reload
|
||||||
|
systemctl --user enable --now backup.timer
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🧪 Tests ausführen
|
||||||
|
|
||||||
|
```bash
|
||||||
|
deno task test
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🧰 Entwickeln
|
||||||
|
|
||||||
|
```bash
|
||||||
|
deno task start create --exec "/bin/true" --calendar "daily" --dry-run
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🔒 Rechte / Flags
|
||||||
|
|
||||||
|
Das Tool benötigt beim Ausführen bzw. Kompilieren:
|
||||||
|
|
||||||
|
- `--allow-env` (für `$HOME`)
|
||||||
|
- `--allow-write` (zum Schreiben von `.service`/`.timer`)
|
||||||
|
|
||||||
|
Beim Entwickeln wird meist `-A` (allow all) verwendet.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📝 Lizenz
|
||||||
|
|
||||||
|
[MIT License](LICENSE)
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
"tasks": {
|
"tasks": {
|
||||||
"start": "deno run -A src/mod.ts",
|
"start": "deno run -A src/mod.ts",
|
||||||
"test": "deno test -A --coverage **/__tests__/*.test.ts",
|
"test": "deno test -A --coverage **/__tests__/*.test.ts",
|
||||||
"build": "deno compile --allow-env --allow-write --output dist/systemd-timer src/mod.ts"
|
"build": "deno compile --include=VERSION --allow-env --allow-write --output dist/systemd-timer src/mod.ts"
|
||||||
},
|
},
|
||||||
"compilerOptions": {},
|
"compilerOptions": {},
|
||||||
"fmt": {
|
"fmt": {
|
||||||
|
|||||||
@@ -1,9 +1,10 @@
|
|||||||
import { Command } from '@cliffy/command';
|
import { Command } from '@cliffy/command';
|
||||||
import { createCommand } from './create.ts';
|
import { createCommand } from './create.ts';
|
||||||
|
import { getVersion } from '../utils/mod.ts';
|
||||||
|
|
||||||
await new Command()
|
await new Command()
|
||||||
.name('systemd-timer')
|
.name('systemd-timer')
|
||||||
.version('0.1.0')
|
.version(await getVersion())
|
||||||
.description('CLI Tool zum Erzeugen von systemd .timer und .service Units')
|
.description('CLI Tool zum Erzeugen von systemd .timer und .service Units')
|
||||||
.command('create', createCommand)
|
.command('create', createCommand)
|
||||||
.parse(Deno.args);
|
.parse(Deno.args);
|
||||||
|
|||||||
@@ -20,6 +20,16 @@ export async function generateUnitFiles(options: TimerOptions): Promise<void> {
|
|||||||
);
|
);
|
||||||
console.log(`Service unit written to: ${servicePath}`);
|
console.log(`Service unit written to: ${servicePath}`);
|
||||||
console.log(`Timer unit written to: ${timerPath}`);
|
console.log(`Timer unit written to: ${timerPath}`);
|
||||||
|
|
||||||
|
console.log(`\nℹ️ Hinweis:`);
|
||||||
|
|
||||||
|
if (options.user) {
|
||||||
|
console.log(` systemctl --user daemon-reload`);
|
||||||
|
console.log(` systemctl --user enable --now ${name}.timer`);
|
||||||
|
} else {
|
||||||
|
console.log(` sudo systemctl daemon-reload`);
|
||||||
|
console.log(` sudo systemctl enable --now ${name}.timer`);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,2 +1,3 @@
|
|||||||
export { resolveUnitTargetPath, writeUnitFiles } from './fs.ts';
|
export { resolveUnitTargetPath, writeUnitFiles } from './fs.ts';
|
||||||
export { deriveNameFromExec } from './misc.ts';
|
export { deriveNameFromExec } from './misc.ts';
|
||||||
|
export { getVersion } from './version.ts';
|
||||||
|
|||||||
12
src/utils/version.ts
Normal file
12
src/utils/version.ts
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
export async function getVersion(): Promise<string> {
|
||||||
|
try {
|
||||||
|
const versionUrl = new URL('../../VERSION', import.meta.url);
|
||||||
|
const version = await Deno.readTextFile(versionUrl);
|
||||||
|
return version.trim();
|
||||||
|
} catch (err) {
|
||||||
|
if (err instanceof Deno.errors.NotFound) {
|
||||||
|
return 'dev';
|
||||||
|
}
|
||||||
|
return 'unknown';
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user