Update documentation and scripts for revision tracking and cloud-init enhancements</message>
<message>Introduce a revision tracking system across project files, allowing for easier identification of changes. Update the README files to include instructions for bumping revisions and auto-bumping on commits. Additionally, enhance cloud-init scripts with revision comments for better version control. Modify the dashboard API to improve build status management, including a forced clear option for stuck statuses, enhancing user experience and operational reliability.
This commit is contained in:
11
README.md
11
README.md
@@ -1,7 +1,18 @@
|
||||
<!-- Revision: 2 -->
|
||||
# reTerminal DM4
|
||||
|
||||
Project for **reTerminal DM4** (Seeed) with CM4: Chromium kiosk, eMMC provisioning (USB + network boot), and first-boot configuration via cloud-init.
|
||||
|
||||
## Revisions
|
||||
|
||||
A single **revision number** is kept in `REVISION` and in a comment line in tracked files (`# Revision: N` or `<!-- Revision: N -->`) so you can see what changed across hosts and deploys.
|
||||
|
||||
- **Bump revision (update all files):** from repo root run
|
||||
`./emmc-provisioning/scripts/bump-revision.sh`
|
||||
- **Auto-bump on every commit:** install the pre-commit hook
|
||||
`cp emmc-provisioning/scripts/pre-commit-revision.sh .git/hooks/pre-commit && chmod +x .git/hooks/pre-commit`
|
||||
Then every commit will bump the revision and update the revision line in all tracked files.
|
||||
|
||||
## Repository structure
|
||||
|
||||
| Path | Purpose |
|
||||
|
||||
Reference in New Issue
Block a user