mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-11-14 00:01:03 +00:00
Maurice
bc385f27dd
Add the paddle region alert, the to-do reminders, the new audit keys for Tours, paddle water, wanderer and AI, the release history paging and the backup hour hint. Dashes are replaced with plain punctuation.
53 lines
3.2 KiB
Markdown
53 lines
3.2 KiB
Markdown
# Admin: GitHub Releases
|
|
|
|
The **GitHub** tab (in the **Integrations** group of the admin side navigation) shows the TREK release history fetched from GitHub and provides links to community resources and support options.
|
|
|
|
|
|
|
|
## Support and resources
|
|
|
|
The **About** card at the top of the tab holds six tiles that link to external resources:
|
|
|
|
| Card | Link |
|
|
|------|------|
|
|
| **Ko-fi** | Support the project financially |
|
|
| **Buy Me a Coffee** | Alternative support link |
|
|
| **Discord** | Join the TREK community |
|
|
| **Report a Bug** | Open a GitHub issue with the bug report template |
|
|
| **Feature Request** | Open a GitHub Discussion in the feature requests category |
|
|
| **Wiki** | Open the GitHub Wiki |
|
|
|
|
## Release timeline
|
|
|
|
Below it, the **Release History** card ("Latest updates from liketrek/TREK", with a GitHub button in its head) holds a chronological timeline of GitHub releases for the `liketrek/TREK` repository. Each entry shows:
|
|
|
|
- **Version tag** (e.g., `v2.9.14`)
|
|
- A **Latest** badge on the first (most recent) entry in the displayed list, and a **Pre-release** badge on pre-releases
|
|
- **Release date** and author
|
|
- A **Show details / Hide details** toggle that expands the release notes (a small Markdown subset rendered inline: `##` and `###` headings, `-` or `*` list items, **bold**, `code` and http(s) links; anything else is shown as plain text)
|
|
|
|
Pre-release entries are hidden unless the server has both found a newer version and is itself running a pre-release. In every other case, including a pre-release install that is already on the newest pre-release, the timeline shows stable releases only.
|
|
|
|
Releases load 10 at a time. Click **Load more** at the bottom of the timeline to fetch additional pages. While pre-releases are hidden, one load may read up to five pages so that it does not come back empty when the newest releases are all pre-releases.
|
|
|
|
If the admin API request fails, the card shows **Failed to load releases**. If the server cannot reach the GitHub API, the timeline displays no releases (the server returns an empty list rather than an error).
|
|
|
|
## Version check
|
|
|
|
The server checks for available updates daily at 9 AM (server timezone, defaults to UTC) and sends an admin notification when a newer version is published. When an update is available, a banner also appears at the top of the Admin page on next load.
|
|
|
|
Results are cached for 5 minutes to avoid repeated API calls.
|
|
|
|
## Release notes notice
|
|
|
|
After an update, every user is shown a **release notes** notice once: a modal on the desktop with what the release brought (a few headline cards), a note from the maintainer, the support links and a **Release notes** link to the release on GitHub. Closing it keeps it closed for the version that is running; the next version brings it back once, a patch release included. There is no switch for it in the admin panel. The phone has its own onboarding instead.
|
|
|
|
## When to check
|
|
|
|
Review the GitHub tab before performing an upgrade to read the release notes for any versions between your current install and the target version. See [Updating](Updating) for the upgrade procedure.
|
|
|
|
## Related pages
|
|
|
|
- [Updating](Updating)
|
|
- [Admin-Panel-Overview](Admin-Panel-Overview)
|