Skip to content

docs: add API example for image promotion between branches#280

Merged
forfoxssake merged 3 commits intomainfrom
docs/image-promotion-api-example
May 5, 2026
Merged

docs: add API example for image promotion between branches#280
forfoxssake merged 3 commits intomainfrom
docs/image-promotion-api-example

Conversation

@forfoxssake
Copy link
Copy Markdown
Contributor

Summary

  • Adds a new "Promoting an image to another branch" section to the API usage examples page
  • Documents the two-step workflow: finding an image's internal name via fieldSelector, then creating an ImagePromotion resource to promote it to a target branch

Notes

  • API-only for now; UI documentation will follow in a separate PR
  • Links to the relevant API reference endpoints (listImage, createImagePromotion)

Copilot AI review requested due to automatic review settings April 29, 2026 10:48
@forfoxssake forfoxssake requested a review from a team as a code owner April 29, 2026 10:48
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds documentation for promoting a container image from one branch to another via the REST API, describing the required lookup + promotion workflow.

Changes:

  • Adds a new “Promoting an image to another branch” section with a two-step workflow.
  • Provides curl examples for listing/filtering images and creating an ImagePromotion.
  • Adds a variables table and links to the relevant API reference endpoints.

Comment thread src/multiplayer-servers/api/examples.md Outdated
Comment thread src/multiplayer-servers/api/examples.md Outdated
Comment thread src/multiplayer-servers/api/examples.md Outdated
Comment thread src/multiplayer-servers/api/examples.md
Comment thread src/multiplayer-servers/api/examples.md Outdated
Copilot AI review requested due to automatic review settings May 4, 2026 14:46
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread src/multiplayer-servers/api/examples.md
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a nitpick, and a question about whether the new sentence is factually correct. If it is, it means the previous docs were plain false.

Comment thread src/multiplayer-servers/api/examples.md
@forfoxssake forfoxssake merged commit abd5139 into main May 5, 2026
9 checks passed
@forfoxssake forfoxssake deleted the docs/image-promotion-api-example branch May 5, 2026 12:44
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.

4 participants