Skip to content

Latest commit

 

History

History
52 lines (36 loc) · 4.4 KB

FORK.md

File metadata and controls

52 lines (36 loc) · 4.4 KB

Community fork

This repository is an independent community fork of UpCloudLtd/upcloud-cli. It tracks upstream releases and carries fixes that have not (yet) been merged upstream. Changes are kept small and self-contained so that upstream can merge them at any time.

Versioning

  • Fork releases are always suffixed with -community, e.g. 3.37.1-community (git tag v3.37.1-community).
  • The base version is the upstream release the fork is synced to; fork-only changes bump the patch (or minor) component on top of it.
  • Like upstream, the binary version is derived from the git tag at build time (goreleaser injects it into internal/config.Version); release preparation only updates CHANGELOG.md.
  • Compare links for -community versions point to this fork; links for upstream versions point to UpCloudLtd/upcloud-cli.

Feature parity

Base: upstream v3.37.0 (2026-10-13). The fork contains all upstream features; no upstream feature is removed or disabled.

Fork-only changes

Change Introduced in Related issue Upstream status
kubernetes node-group scale --count 0 sends {"count": 0} instead of silently doing nothing. The command now uses the v9 SDK; JSON/YAML output shape is preserved. 3.37.1-community #1 Not fixed as of upstream v3.37.0
Command help no longer shows Default: for required flags (e.g. scale --count showed a misleading Default: 0). 3.37.1-community #1 Not fixed as of upstream v3.37.0
server plans --prices: -o json/-o yaml now include the computed price (price field per plan, omitted when unknown). 3.37.2-community #805 Open upstream
server show: -o json/-o yaml now include firewall rules (firewall_rules field); previously only the default human view showed them. 3.37.2-community #805 No upstream issue

Notes for upstream merging

  • The scale fix works around a bug in the upcloud-go-api v8 SDK: request.ModifyKubernetesNodeGroup.Count is tagged json:"count,omitempty", so a zero count is dropped from the PATCH body and the API no-ops while the CLI reports success. The v9 SDK (KubernetesNodeGroupPatch) models count without omitempty and is not affected. Fixing the v8 SDK would additionally benefit all other v8 consumers.
  • The help renderer change is in internal/ui/usage.go (formatFlags) and applies to every command with required flags.
  • The JSON output fixes follow the existing server list --show-ip-addresses pattern (serverWithIPAddress): wrapper structs embed the SDK response, so existing JSON/YAML fields are preserved and the enriched fields are additive. An audit of all commands found these two were the only ones rendering data in human output that was missing from machine output.

CI and releases

The fork runs the upstream workflows with a release pipeline adapted for the fork:

  • test, lint, codeql: run as upstream, no secrets needed. Superseded runs on the same PR or branch are cancelled automatically.
  • docs: manual workflow_dispatch only here. Upstream deploys the MkDocs site to gh-pages on main pushes and releases; run it manually and enable GitHub Pages if you want the site.
  • examples: manual workflow_dispatch only here. Run when necessary, as it creates billable resources.
  • publish: on tags matching v*.*.* (e.g. v3.37.1-community), builds binaries, deb/rpm/apk packages, checksums, and SBOMs, creates a draft GitHub release on this fork (marked as prerelease for -community tags), pushes container images to ghcr.io/upcloud-tools/upctl, and attaches build provenance attestations. Publish the draft release manually after review.

Differences from upstream: no Docker Hub (upcloud/upctl), or Homebrew tap publishing. Everything else uses the automatic GITHUB_TOKEN; no additional secrets are needed for releases.

Syncing with upstream

git remote add upstream git@github.com:UpCloudLtd/upcloud-cli.git
git fetch upstream
git merge upstream/main

After syncing: update the base version above, drop fork-only changes that upstream merged from the table, and base the next -community version on the new upstream release.