osp-release

README

osp-release

osp-release is a small Go CLI for looking up OpenShift Pipelines release data from Confluence, Jira, and upstream GitHub releases.

Install

go install github.com/openshift-pipelines/osp-release/cmd/osp-release@latest

Homebrew:

brew tap openshift-pipelines/osp-release https://github.com/openshift-pipelines/osp-release
brew install --cask osp-release

Linux packages are published on GitHub Releases as .deb, .rpm, and .apk artifacts.

Auth

Release and component commands need Jira credentials.

Use env vars:

export OSP_JIRA_EMAIL='you@example.com'
export OSP_JIRA_TOKEN='token'

Or use pass:: references:

export OSP_JIRA_EMAIL='pass::jira/email'
export OSP_JIRA_TOKEN='pass::jira/token'

Flags override env vars:

osp-release release latest --jira-email 'pass::jira/email' --jira-token 'pass::jira/token'

upstream commands use normal GitHub CLI auth conventions through the official go-gh library.

Component Catalog

The component catalog lives in internal/release/components.yaml and is embedded into the binary at build time.

What is components.yaml?

This file defines the complete component catalog for OpenShift Pipelines releases. It maps component identifiers (keys) to display names and upstream GitHub repositories. When you run commands like osp-release component list or fetch release versions, this file provides the source of truth for which components exist and where their releases are tracked.

File Structure

display_names:
  # Keys used in output headers and field selectors
  minor: OSP Minor              # Release minor version (e.g., "1.21")
  version: OSP Version          # Full release version (e.g., "1.21.0")
  released: Released            # Release date
  component: Component          # Component name column header
  value: Version                # Component version column header
  repo: Repository              # Repository URL column header
  name: Component               # Alternative component name header
  minimum_k8s_version: Minimum Kubernetes  # Min K8s version requirement

components:
  - key: pac                    # Component identifier (used in CLI)
    display_name: Pipelines as Code  # Human-readable name
    repo: tektoncd/pipelines-as-code  # GitHub owner/repo for version lookups
  # ... more components

How to Edit

To add a component:

1. Add a new entry under components: with a unique key (lowercase, no spaces)
2. Set display_name to the human-readable name
3. Set repo to the GitHub owner/repo path where releases are tracked

Example:

  - key: mycomponent
    display_name: My Component Name
    repo: owner/repository

To modify display labels, edit the display_names section at the top. These keys control output headers and are used by --field selectors.

To rename a component, update the key and update any documentation or scripts that reference it. The key is part of the CLI interface.

Rebuild After Edits

After editing internal/release/components.yaml, rebuild the binary:

make build

The file is embedded at build time, so changes don't take effect until the binary is rebuilt.

Commands

osp-release release latest
osp-release release show 1.21
osp-release release list --json
osp-release release all --unreleased
osp-release component list
osp-release component show pac
osp-release upstream list
osp-release upstream show pac --field version --quiet

Output

• Default on TTY: table
• Default when piped or redirected: JSON
• Override with --output table|text|json
• Release commands include component versions by default
• Release listings hide unreleased versions unless --unreleased is passed
• Use --field to select stable fields
• Use --no-components to hide component versions in release output
• Use --quiet with a single --field for bare values
• Use --no-headers to hide table headers

Examples:

osp-release release latest --field version
osp-release release show 1.21
osp-release release latest --no-components
osp-release release list --unreleased
osp-release release list --field minor --field version --output text
osp-release upstream list --json

Development

make build
make test
make lint
make release-snapshot

Release

CI runs tests, lint, and goreleaser check. Tags publish release archives, Homebrew casks, and Linux packages with GoReleaser.

The Homebrew cask is published directly to homebrew/Casks/ in this repository using the workflow's GITHUB_TOKEN.