swag: auto-uptime-kuma add Uptime Kuma v2 support #1097
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull request overview
This PR adds support for Uptime Kuma v2.x while maintaining backwards compatibility with v1.x through a new environment variable UPTIME_KUMA_API_VERSION. The change allows users to select between the original uptime-kuma-api package (v1) and the maintained uptime-kuma-api-v2 fork (v2) based on their Uptime Kuma server version.
Key Changes:
- Added conditional package installation logic based on
UPTIME_KUMA_API_VERSIONenvironment variable (defaults to1for backwards compatibility) - Updated documentation to include the new environment variable and reference both API libraries
- Modified installation messages to reflect the new dynamic package selection
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
root/etc/s6-overlay/s6-rc.d/init-mod-swag-auto-uptime-kuma-add-package/run |
Added version detection logic and conditional package selection between uptime-kuma-api (v1) and uptime-kuma-api-v2 (v2) |
README.md |
Added UPTIME_KUMA_API_VERSION to environment variables table and updated API library references in documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
root/etc/s6-overlay/s6-rc.d/init-mod-swag-auto-uptime-kuma-add-package/run
Outdated
Show resolved
Hide resolved
root/etc/s6-overlay/s6-rc.d/init-mod-swag-auto-uptime-kuma-add-package/run
Show resolved
Hide resolved
Add UPTIME_KUMA_API_VERSION environment variable to support both Uptime Kuma v1.x and v2.x. - Default to v1 (uptime-kuma-api) for backwards compatibility - Set UPTIME_KUMA_API_VERSION=2 to use v2 (uptime-kuma-api-v2) - Updated README with new environment variable documentation - Updated library references in documentation Signed-off-by: Ben Lawson <rubiss@gmail.com>
Rubiss
force-pushed
the
swag-auto-uptime-kuma
branch
from
668aeca to
0759888
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
This PR adds support for Uptime Kuma v2.x while maintaining backwards compatibility with v1.x through a new environment variable
UPTIME_KUMA_API_VERSION.Changes:
UPTIME_KUMA_API_VERSIONenvironment variable (defaults to1)1(default): installsuptime-kuma-apipackage for Uptime Kuma v1.x2: installsuptime-kuma-api-v2package for Uptime Kuma v2.xBenefits of this PR and context:
Uptime Kuma v2.x was released with breaking API changes. The original
uptime-kuma-apipackage by lucasheld is no longer maintained and doesn't support v2.x.This PR:
UPTIME_KUMA_API_VERSION=2uptime-kuma-api-v2package (a maintained fork) for v2 supportHow Has This Been Tested?
Tested manually with both Uptime Kuma versions:
uptime-kuma-apiuptime-kuma-api-v2Test process:
Source / References: