Skip to content

docs: document targeting a step's Git resource (git_resources) at release creation#3248

Merged
NickJosevski merged 1 commit into
mainfrom
sf2251-git-resources-docs
Jul 21, 2026
Merged

docs: document targeting a step's Git resource (git_resources) at release creation#3248
NickJosevski merged 1 commit into
mainfrom
sf2251-git-resources-docs

Conversation

@NickJosevski

@NickJosevski NickJosevski commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Adds a Targeting a step's Git resource section to the build-server-plugin release-creation page, alongside the existing per-build-server Git Reference / Git Commit guidance.

Why: the create-release GitHub Action shipped a git_resources input in v4.2.0, and the CLI has --git-resource, but there was no public doc for choosing a step's Git resource branch/tag at release creation (e.g. deploying a feature branch of an Update Argo CD Application Manifests source). Customer request SF-2251.

Content:

  • Explains git_resources is distinct from the project's own Git Reference/Commit and is resolved at release-creation time (so it can't be a deployment variable).
  • GitHub Action + CLI usage, with the github.head_ref || github.ref_name per-event pattern.
  • Cross-links the Argo manifests step and the CLI reference.

Related: create-release-action (feature) + (README), api-client.ts

@team-marketing-branch-protections

Copy link
Copy Markdown

Pull request environment is available at https://stoctodocspr3248.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.

Adds a section to the build-server-plugin release-creation page covering the
git_resources input (create-release GitHub Action v4.2.0+) and the CLI
--git-resource flag, for targeting a step's Git resource branch/tag (e.g. the
Update Argo CD Application Manifests source) from CI. Clarifies it is distinct
from the project's Git Reference/Commit and is resolved at release-creation
time (SF-2251).
@NickJosevski
NickJosevski force-pushed the sf2251-git-resources-docs branch from 9d44ee0 to c7f9a5a Compare July 21, 2026 08:54
@NickJosevski
NickJosevski enabled auto-merge (rebase) July 21, 2026 08:56

@steve-fenton-octopus steve-fenton-octopus left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM!

@NickJosevski
NickJosevski merged commit 81fccfc into main Jul 21, 2026
7 checks passed
@NickJosevski
NickJosevski deleted the sf2251-git-resources-docs branch July 21, 2026 09:15
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.

3 participants