Skip to content

docs: add a Buildkite build server page - #3426

Open
NickJosevski wants to merge 1 commit into
mainfrom
nj/buildkite-docs
Open

docs: add a Buildkite build server page#3426
NickJosevski wants to merge 1 commit into
mainfrom
nj/buildkite-docs

Conversation

@NickJosevski

Copy link
Copy Markdown
Contributor

Why

getting-started/index.mdx lists BuildKite among the CI systems we "provide first-class integrations with" and give guides for. There is no such page — build-servers/ documents nine other systems and not this one. Buildkite users following that promise land nowhere.

What's in it

Everything here was verified end to end against a Buildkite hosted agent and an Octopus Cloud instance, not inferred from the API:

  • Installing the CLI. It is not preinstalled on Buildkite agents, including hosted ones, and there's no Buildkite equivalent of install-octopus-cli. The page gives the tarball recipe that was actually used.
  • OpenID Connect, with the full token-exchange script, since there's no login plugin for Buildkite yet.
  • Creating a release, via the create-release plugin or the CLI directly.
  • Build information — honestly marked as not yet having a plugin.
  • Troubleshooting, drawn from the failures actually hit.

The bit I'd most want reviewed

Buildkite's subject claim pins the commit SHA:

organization:ORG:pipeline:PIPELINE:ref:REF:commit:COMMIT:step:STEP_KEY

So a subject copied verbatim from a working build authorises exactly that build and then silently never matches again — with an error that gives no hint which half is wrong. commit:* is effectively mandatory. That's in a warning callout, and it's the single thing most likely to cost a customer an afternoon.

It's also the strongest argument for eventually giving Buildkite a guided issuer type in the portal like GitHub Actions has, rather than leaving people to hand-write a five-segment subject in a free-text field.

Also

  • Adds Buildkite to the list on build-servers/index.md (alphabetical, navOrder: 45 between BitBucket Pipelines and Codefresh).
  • All 7 internal /docs/... links verified to resolve to real pages.

Known gaps this page documents rather than fixes

No login plugin, no build-information plugin, no CLI-install plugin for Buildkite. The page tells the truth about each rather than omitting them.

🤖 Generated with Claude Code

getting-started lists BuildKite among the CI systems we provide guides
for, but no such page exists — build-servers documents nine other systems
and not this one. Buildkite users have had nothing to follow.

Covers what was verified end to end against a Buildkite hosted agent and
an Octopus Cloud instance: installing the CLI (it is not preinstalled on
Buildkite agents), the OpenID Connect token exchange, the create-release
plugin, and the traps.

The most important of those is the subject claim. Buildkite's includes the
commit SHA, so a subject copied from one build authorises only that build
and then silently never matches again. The page calls that out in a warning
with the wildcard form.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@team-marketing-branch-protections

Copy link
Copy Markdown

Pull request environment is available at https://stoctodocspr3426.z22.web.core.windows.net.

You can view the ephemeral environment status in Octopus Deploy.

This environment will be automatically deprovisioned when the pull request is closed, or after 7 days of inactivity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants