Compare commits
17 Commits
Author | SHA1 | Date | |
---|---|---|---|
ef052e9f66 | |||
c53576a700
|
|||
3d74ec37e4 | |||
c4855ed3fb
|
|||
07ee03b6be
|
|||
fb2a62d984
|
|||
113103f368
|
|||
f112002249 | |||
0c1d8be79f
|
|||
e3caf0bba9 | |||
287cd741b4
|
|||
8b29105686 | |||
27c7367ef1
|
|||
f9cef4b70d | |||
e3a3e61bce
|
|||
bcec1f8f90 | |||
cf483de06b
|
@@ -4,7 +4,7 @@ on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- '**'
|
||||
- "**"
|
||||
|
||||
jobs:
|
||||
detect-version-change:
|
||||
@@ -125,7 +125,7 @@ jobs:
|
||||
if: steps.restore-cliff.outputs.cache-hit != 'true'
|
||||
run: |
|
||||
cargo install git-cliff --version "${{ steps.cliff_version.outputs.version }}" --features gitea
|
||||
|
||||
|
||||
- name: Generate changelog for release and tag
|
||||
id: generate-changelog
|
||||
run: |
|
||||
@@ -152,7 +152,6 @@ jobs:
|
||||
|
||||
echo "changelog_body_path=$BODY" >> $GITHUB_OUTPUT
|
||||
|
||||
|
||||
- name: Commit updated CHANGELOG
|
||||
run: |
|
||||
git add CHANGELOG.md
|
||||
@@ -169,12 +168,14 @@ jobs:
|
||||
if git rev-parse "v$VERSION" >/dev/null 2>&1; then
|
||||
echo "Tag v$VERSION already exists, skipping tag creation."
|
||||
else
|
||||
export GIT_AUTHOR_DATE="$(date --iso-8601=seconds)"
|
||||
export GIT_COMMITTER_DATE="$GIT_AUTHOR_DATE"
|
||||
git tag -a "v$VERSION" -F "${{ steps.generate-changelog.outputs.changelog_body_path }}" --cleanup=verbatim
|
||||
git push origin "v$VERSION"
|
||||
fi
|
||||
|
||||
- name: Create Gitea release
|
||||
env:
|
||||
env:
|
||||
RELEASE_PUBLISH_TOKEN: ${{ secrets.RELEASE_PUBLISH_TOKEN }}
|
||||
run: |
|
||||
VERSION=${{ steps.version.outputs.value }}
|
||||
|
@@ -42,3 +42,15 @@ jobs:
|
||||
|
||||
- name: Upload SHA256 for ${{ matrix.target }}-${{ matrix.arch }}
|
||||
run: .gitea/scripts/upload-asset.sh ./dist/systemd-timer-${{ matrix.target }}-${{ matrix.arch }}.sha256 systemd-timer-${{ matrix.target }}-${{ matrix.arch }}.sha256
|
||||
|
||||
- name: Run Releases Sync Action
|
||||
uses: https://git.0xmax42.io/actions/releases-sync@main
|
||||
with:
|
||||
gitea_token: ${{ secrets.RELEASE_PUBLISH_TOKEN }}
|
||||
gitea_url: https://git.0xmax42.io
|
||||
gitea_owner: maxp
|
||||
gitea_repo: systemd-timer
|
||||
tag_name: ${{ github.event.release.tag_name }}
|
||||
github_token: ${{ secrets.SYNC_GITHUB_TOKEN }}
|
||||
github_owner: 0xmax42
|
||||
github_repo: systemd-timer
|
||||
|
29
CHANGELOG.md
29
CHANGELOG.md
@@ -2,6 +2,35 @@
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
## [0.3.1](https://git.0xmax42.io/maxp/systemd-timer/compare/v0.2.3..v0.3.1) - 2025-05-28
|
||||
|
||||
### 🚀 Features
|
||||
|
||||
- *(cli)* Add options for user, home, and working directory - ([113103f](https://git.0xmax42.io/maxp/systemd-timer/commit/113103f368ead3014165cc708f016a04749f59be))
|
||||
|
||||
### 📚 Documentation
|
||||
|
||||
- *(readme)* Expand CLI option descriptions for clarity - ([fb2a62d](https://git.0xmax42.io/maxp/systemd-timer/commit/fb2a62d984615caa4035fd5c1e8e64d245499e47))
|
||||
|
||||
### 🎨 Styling
|
||||
|
||||
- *(workflows)* Fix formatting and whitespace issues - ([c4855ed](https://git.0xmax42.io/maxp/systemd-timer/commit/c4855ed3fbc0ada208690f90932710983daef392))
|
||||
|
||||
### ⚙️ Miscellaneous Tasks
|
||||
|
||||
- *(workflows)* Consolidate release sync into upload workflow - ([0c1d8be](https://git.0xmax42.io/maxp/systemd-timer/commit/0c1d8be79f0cc331db9029beb46384659f465f6e))
|
||||
|
||||
## [0.2.3](https://git.0xmax42.io/maxp/systemd-timer/compare/v0.2.2..v0.2.3) - 2025-05-26
|
||||
|
||||
### 🚀 Features
|
||||
|
||||
- *(workflows)* Add GitHub release synchronization workflow - ([27c7367](https://git.0xmax42.io/maxp/systemd-timer/commit/27c7367ef1799428cc5a491b25036f77b65758af))
|
||||
|
||||
### 📚 Documentation
|
||||
|
||||
- *(readme)* Update project time badge interval - ([e3a3e61](https://git.0xmax42.io/maxp/systemd-timer/commit/e3a3e61bce0e62c2397bbc5bde3eff81b915c94a))
|
||||
- Add Englisch README - ([cf483de](https://git.0xmax42.io/maxp/systemd-timer/commit/cf483de06b555599052b1d9f97ee98e9233e5a86))
|
||||
|
||||
## [0.2.2](https://git.0xmax42.io/maxp/systemd-timer/compare/v0.2.0..v0.2.2) - 2025-05-22
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
107
README.DE.md
Normal file
107
README.DE.md
Normal file
@@ -0,0 +1,107 @@
|
||||
# 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`: Zeitplan für den Timer (systemd `OnCalendar`)
|
||||
- `--exec`: Auszuführendes Kommando (`ExecStart`)
|
||||
- `--description`: Beschreibung für die Unit
|
||||
- `--after`: `After=`-Abhängigkeiten in der Service-Unit
|
||||
- `--environment`: Beliebige `Environment=KEY=VALUE` Einträge
|
||||
- `--output`: Zielverzeichnis für die generierten Unit-Dateien
|
||||
- `--run-as`: Setzt `User=` in der Service-Unit (nur systemweite Timer)
|
||||
- `--home`: Setzt `Environment=HOME=…`
|
||||
- `--cwd`: Arbeitsverzeichnis des Prozesses (`WorkingDirectory`)
|
||||
- `--dry-run`: Gibt nur die generierten Inhalte aus, ohne sie zu schreiben
|
||||
- Getestet und typisiert mit **Deno** + **Cliffy**
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Installation
|
||||
|
||||
|
||||
Du kannst `systemd-timer` direkt per Shell-Skript installieren:
|
||||
|
||||
```bash
|
||||
curl -fsSL https://git.0xmax42.io/maxp/systemd-timer/raw/branch/main/scripts/install.sh | sh
|
||||
```
|
||||
|
||||
Das Skript erkennt automatisch deine Plattform (Linux `amd64` oder `arm64`) und installiert die passende Binary nach `/usr/local/bin`, sofern dies erlaubt ist (ggf. mit `sudo`).
|
||||
|
||||
**Hinweis:**
|
||||
- Für die Installation ist eine funktionierende Internetverbindung notwendig.
|
||||
- Die Integrität der Binary wird mittels SHA256-Prüfsumme verifiziert.
|
||||
- Du kannst das Skript vor der Ausführung auch manuell inspizieren:
|
||||
|
||||
```bash
|
||||
curl -fsSL https://git.0xmax42.io/maxp/systemd-timer/raw/branch/main/scripts/install.sh -o install.sh
|
||||
less install.sh
|
||||
```
|
||||
|
||||
Weitere Optionen und manuelle Installationswege findest du unter [`scripts/install.sh`](scripts/install.sh).
|
||||
|
||||
---
|
||||
|
||||
## 📦 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)
|
74
README.md
74
README.md
@@ -1,53 +1,58 @@
|
||||
# systemd-timer
|
||||
|
||||

|
||||
- 
|
||||
- [Deutsche Version dieser Readme](README.DE.md)
|
||||
|
||||
Ein einfaches CLI-Tool zum schnellen Erzeugen von systemd `.service` und `.timer` Units – als Ersatz oder moderne Ergänzung zu klassischen `cron`-Jobs.
|
||||
A simple CLI tool for quickly generating systemd `.service` and `.timer` units — as a replacement or modern supplement to classic `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
|
||||
* Generates `.service` and `.timer` files via CLI
|
||||
* Supports `--user` timers (for `~/.config/systemd/user/`)
|
||||
* Optional logging (`StandardOutput/StandardError`)
|
||||
* Supports:
|
||||
* `--calendar`: Timer schedule (systemd `OnCalendar`)
|
||||
* `--exec`: Command to execute (`ExecStart`)
|
||||
* `--description`: Description for the unit
|
||||
* `--after`: `After=` dependencies in the service unit
|
||||
* `--environment`: Arbitrary `Environment=KEY=VALUE` entries
|
||||
* `--output`: Target directory for the generated unit files
|
||||
* `--run-as`: Sets `User=` in the service unit (only for system-level timers)
|
||||
* `--home`: Sets `Environment=HOME=…`
|
||||
* `--cwd`: Working directory for the process (`WorkingDirectory`)
|
||||
* `--dry-run`: Outputs unit content without writing to disk
|
||||
* Tested and fully typed with **Deno** + **Cliffy**
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Installation
|
||||
|
||||
|
||||
Du kannst `systemd-timer` direkt per Shell-Skript installieren:
|
||||
You can install `systemd-timer` directly via shell script:
|
||||
|
||||
```bash
|
||||
curl -fsSL https://git.0xmax42.io/maxp/systemd-timer/raw/branch/main/scripts/install.sh | sh
|
||||
```
|
||||
|
||||
Das Skript erkennt automatisch deine Plattform (Linux `amd64` oder `arm64`) und installiert die passende Binary nach `/usr/local/bin`, sofern dies erlaubt ist (ggf. mit `sudo`).
|
||||
The script automatically detects your platform (Linux `amd64` or `arm64`) and installs the appropriate binary to `/usr/local/bin`, if permitted (possibly using `sudo`).
|
||||
|
||||
**Hinweis:**
|
||||
- Für die Installation ist eine funktionierende Internetverbindung notwendig.
|
||||
- Die Integrität der Binary wird mittels SHA256-Prüfsumme verifiziert.
|
||||
- Du kannst das Skript vor der Ausführung auch manuell inspizieren:
|
||||
**Note:**
|
||||
|
||||
* A working internet connection is required for installation.
|
||||
* The integrity of the binary is verified using a SHA256 checksum.
|
||||
* You can manually inspect the script before execution:
|
||||
|
||||
```bash
|
||||
curl -fsSL https://git.0xmax42.io/maxp/systemd-timer/raw/branch/main/scripts/install.sh -o install.sh
|
||||
less install.sh
|
||||
```
|
||||
|
||||
Weitere Optionen und manuelle Installationswege findest du unter [`scripts/install.sh`](scripts/install.sh).
|
||||
Additional options and manual installation methods are available under [`scripts/install.sh`](scripts/install.sh).
|
||||
|
||||
---
|
||||
|
||||
## 📦 Beispiel
|
||||
## 📦 Example
|
||||
|
||||
```bash
|
||||
./systemd-timer create \
|
||||
@@ -58,11 +63,12 @@ Weitere Optionen und manuelle Installationswege findest du unter [`scripts/insta
|
||||
--logfile "/var/log/backup.log"
|
||||
```
|
||||
|
||||
Erzeugt:
|
||||
- `~/.config/systemd/user/backup.service`
|
||||
- `~/.config/systemd/user/backup.timer`
|
||||
This creates:
|
||||
|
||||
Anschließend aktivieren:
|
||||
* `~/.config/systemd/user/backup.service`
|
||||
* `~/.config/systemd/user/backup.timer`
|
||||
|
||||
Activate afterwards:
|
||||
|
||||
```bash
|
||||
systemctl --user daemon-reload
|
||||
@@ -71,7 +77,7 @@ systemctl --user enable --now backup.timer
|
||||
|
||||
---
|
||||
|
||||
## 🧪 Tests ausführen
|
||||
## 🧪 Running Tests
|
||||
|
||||
```bash
|
||||
deno task test
|
||||
@@ -79,7 +85,7 @@ deno task test
|
||||
|
||||
---
|
||||
|
||||
## 🧰 Entwickeln
|
||||
## 🧰 Development
|
||||
|
||||
```bash
|
||||
deno task start create --exec "/bin/true" --calendar "daily" --dry-run
|
||||
@@ -87,17 +93,17 @@ deno task start create --exec "/bin/true" --calendar "daily" --dry-run
|
||||
|
||||
---
|
||||
|
||||
## 🔒 Rechte / Flags
|
||||
## 🔒 Permissions / Flags
|
||||
|
||||
Das Tool benötigt beim Ausführen bzw. Kompilieren:
|
||||
The tool requires the following permissions when running or compiling:
|
||||
|
||||
- `--allow-env` (für `$HOME`)
|
||||
- `--allow-write` (zum Schreiben von `.service`/`.timer`)
|
||||
* `--allow-env` (for `$HOME`)
|
||||
* `--allow-write` (to write `.service`/`.timer` files)
|
||||
|
||||
Beim Entwickeln wird meist `-A` (allow all) verwendet.
|
||||
During development, usually `-A` (allow all) is used.
|
||||
|
||||
---
|
||||
|
||||
## 📝 Lizenz
|
||||
## 📝 License
|
||||
|
||||
[MIT License](LICENSE)
|
||||
|
@@ -18,6 +18,18 @@ export const createCommand = new Command()
|
||||
})
|
||||
.option('--description <desc:string>', 'Beschreibung des Timers')
|
||||
.option('--user', 'Erstellt die Unit als User-Timer')
|
||||
.option(
|
||||
'--run-as <user:string>',
|
||||
'Führe den systemweiten Timer als bestimmter Benutzer aus (setzt User= in der Service-Unit)',
|
||||
)
|
||||
.option(
|
||||
'--home <path:string>',
|
||||
'HOME-Variable für den Service setzen',
|
||||
)
|
||||
.option(
|
||||
'--cwd <path:string>',
|
||||
'Arbeitsverzeichnis (WorkingDirectory) für den Service-Prozess',
|
||||
)
|
||||
.option('--output <dir:string>', 'Zielverzeichnis der Unit-Dateien')
|
||||
.option(
|
||||
'--after <target:string>',
|
||||
|
@@ -1,4 +1,5 @@
|
||||
import {
|
||||
assert,
|
||||
assertStringIncludes,
|
||||
} from 'https://deno.land/std@0.224.0/assert/mod.ts';
|
||||
import { TimerOptions } from '../../types/mod.ts';
|
||||
@@ -53,3 +54,63 @@ Deno.test('generateUnits berücksichtigt environment und logfile', () => {
|
||||
assertStringIncludes(serviceUnit, 'StandardOutput=append:/var/log/job.log');
|
||||
assertStringIncludes(serviceUnit, 'StandardError=append:/var/log/job.log');
|
||||
});
|
||||
|
||||
Deno.test('generateUnits berücksichtigt runAs', () => {
|
||||
const opts: TimerOptions = {
|
||||
exec: '/bin/true',
|
||||
calendar: 'daily',
|
||||
runAs: 'myuser',
|
||||
};
|
||||
const { serviceUnit } = generateUnits('job', opts);
|
||||
|
||||
assertStringIncludes(serviceUnit, 'User=myuser');
|
||||
});
|
||||
|
||||
Deno.test('generateUnits berücksichtigt home', () => {
|
||||
const opts: TimerOptions = {
|
||||
exec: '/bin/true',
|
||||
calendar: 'daily',
|
||||
home: '/home/myuser',
|
||||
};
|
||||
const { serviceUnit } = generateUnits('job', opts);
|
||||
|
||||
assertStringIncludes(serviceUnit, 'Environment=HOME=/home/myuser');
|
||||
});
|
||||
|
||||
Deno.test('generateUnits berücksichtigt cwd', () => {
|
||||
const opts: TimerOptions = {
|
||||
exec: '/bin/true',
|
||||
calendar: 'daily',
|
||||
cwd: '/srv/app',
|
||||
};
|
||||
const { serviceUnit } = generateUnits('job', opts);
|
||||
|
||||
assertStringIncludes(serviceUnit, 'WorkingDirectory=/srv/app');
|
||||
});
|
||||
|
||||
Deno.test('generateUnits verwendet default.target bei User-Timern', () => {
|
||||
const opts: TimerOptions = {
|
||||
exec: '/bin/true',
|
||||
calendar: 'daily',
|
||||
user: true,
|
||||
};
|
||||
const { timerUnit } = generateUnits('job', opts);
|
||||
|
||||
assertStringIncludes(timerUnit, 'WantedBy=default.target');
|
||||
});
|
||||
|
||||
Deno.test('generateUnits ignoriert runAs bei --user', () => {
|
||||
const opts = {
|
||||
exec: '/bin/true',
|
||||
calendar: 'daily',
|
||||
user: true,
|
||||
runAs: 'should-not-appear',
|
||||
};
|
||||
|
||||
const { serviceUnit } = generateUnits('job', opts);
|
||||
|
||||
assert(
|
||||
!serviceUnit.includes('User=should-not-appear'),
|
||||
'User= sollte bei --user nicht enthalten sein',
|
||||
);
|
||||
});
|
||||
|
@@ -51,14 +51,18 @@ export function generateUnits(name: string, options: TimerOptions): {
|
||||
`[Service]`,
|
||||
`Type=oneshot`,
|
||||
`ExecStart=${options.exec}`,
|
||||
...(options.cwd ? [`WorkingDirectory=${options.cwd}`] : []),
|
||||
...(options.environment?.map((e) => `Environment=${e}`) ?? []),
|
||||
...(options.home ? [`Environment=HOME=${options.home}`] : []),
|
||||
...(options.logfile
|
||||
? [
|
||||
`StandardOutput=append:${options.logfile}`,
|
||||
`StandardError=append:${options.logfile}`,
|
||||
]
|
||||
: []),
|
||||
...(options.runAs && !options.user ? [`User=${options.runAs}`] : []),
|
||||
];
|
||||
|
||||
if (options.logfile) {
|
||||
unitParts.push(`StandardOutput=append:${options.logfile}`);
|
||||
unitParts.push(`StandardError=append:${options.logfile}`);
|
||||
}
|
||||
|
||||
const serviceUnit = unitParts.join('\n');
|
||||
|
||||
const timerParts = [
|
||||
@@ -70,7 +74,7 @@ export function generateUnits(name: string, options: TimerOptions): {
|
||||
`Persistent=true`,
|
||||
``,
|
||||
`[Install]`,
|
||||
`WantedBy=timers.target`,
|
||||
`WantedBy=${options.user ? 'default.target' : 'timers.target'}`,
|
||||
];
|
||||
|
||||
const timerUnit = timerParts.join('\n');
|
||||
|
@@ -4,6 +4,9 @@ export interface TimerOptions {
|
||||
calendar: string;
|
||||
description?: string;
|
||||
user?: boolean;
|
||||
runAs?: string;
|
||||
home?: string;
|
||||
cwd?: string;
|
||||
output?: string;
|
||||
after?: string[];
|
||||
environment?: string[];
|
||||
|
Reference in New Issue
Block a user