Skip to content

Commit 5e53271

Browse files
WilliamBerryiiiWilliamBerryiii
authored
fix(workflows): remove release-please skip guard that prevents tag creation (#511)
## Description Removed a commit-message guard on the release-please job in the main branch workflow that prevented tag and release creation when release PR merges landed. Release-please v4 handles `chore`-type commits natively, making the guard unnecessary and harmful. - fix(workflows): removed the `if` condition on the `release-please` job in `main.yml` that skipped execution when the head commit started with `chore(main): release`, allowing `createReleases()` to run on release PR merges - docs(architecture): updated `docs/architecture/workflows.md` to explain that release-please v4 handles chore commits natively and removed the stale "(skipped on release commits)" note from the Main Branch Jobs table ## Related Issue(s) Fixes #510 ## Type of Change Select all that apply: **Code & Documentation:** - [x] Bug fix (non-breaking change fixing an issue) - [ ] New feature (non-breaking change adding functionality) - [ ] Breaking change (fix or feature causing existing functionality to change) - [x] Documentation update **Infrastructure & Configuration:** - [x] GitHub Actions workflow - [ ] Linting configuration (markdown, PowerShell, etc.) - [ ] Security configuration - [ ] DevContainer configuration - [ ] Dependency update **AI Artifacts:** - [ ] Reviewed contribution with `prompt-builder` agent and addressed all feedback - [ ] Copilot instructions (`.github/instructions/*.instructions.md`) - [ ] Copilot prompt (`.github/prompts/*.prompt.md`) - [ ] Copilot agent (`.github/agents/*.agent.md`) - [ ] Copilot skill (`.github/skills/*/SKILL.md`) > **Note for AI Artifact Contributors**: > > - **Agents**: Research, indexing/referencing other project (using standard VS Code GitHub Copilot/MCP tools), planning, and general implementation agents likely already exist. Review `.github/agents/` before creating new ones. > - **Skills**: Must include both bash and PowerShell scripts. See [Skills](../docs/contributing/skills.md). > - **Model Versions**: Only contributions targeting the **latest Anthropic and OpenAI models** will be accepted. Older model versions (e.g., GPT-3.5, Claude 3) will be rejected. > - See [Agents Not Accepted](../docs/contributing/custom-agents.md#agents-not-accepted) and [Model Version Requirements](../docs/contributing/ai-artifacts-common.md#model-version-requirements). **Other:** - [ ] Script/automation (`.ps1`, `.sh`, `.py`) - [ ] Other (please describe): ## Testing - Ran `npm run lint:md` with 0 errors on changed files - Ran `npx cspell` with 0 issues on changed files - Validated all 24 workflow files with `actionlint` ## Checklist ### Required Checks - [x] Documentation is updated (if applicable) - [x] Files follow existing naming conventions - [x] Changes are backwards compatible (if applicable) - [ ] Tests added for new functionality (if applicable) ### Required Automated Checks The following validation commands must pass before merging: - [x] Markdown linting: `npm run lint:md` - [x] Spell checking: `npm run spell-check` - [ ] Frontmatter validation: `npm run lint:frontmatter` - [ ] Link validation: `npm run lint:md-links` - [ ] PowerShell analysis: `npm run lint:ps` ## Security Considerations <!-- ⚠️ WARNING: Do not commit sensitive information such as API keys, passwords, or personal data --> - [x] This PR does not contain any sensitive or NDA information - [ ] Any new dependencies have been reviewed for security issues - [ ] Security-related scripts follow the principle of least privilege ## Additional Notes Previously validated in `Azure-Samples/azure-nvidia-robotics-reference-architecture` (PR #175 / issue #174). The guard was originally added for release-please v3 loop prevention, which v4 handles internally by classifying `chore` commits as non-releasable. 🔧 - Generated by Copilot
1 parent 3156d98 commit 5e53271

2 files changed

Lines changed: 11 additions & 12 deletions

File tree

‎.github/workflows/main.yml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,6 @@ jobs:
6464

6565
release-please:
6666
name: Release Please
67-
if: "${{ github.event_name != 'push' || !startsWith(github.event.head_commit.message, 'chore(main): release') }}"
6867
needs:
6968
- spell-check
7069
- markdown-lint

‎docs/architecture/workflows.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -136,20 +136,20 @@ flowchart LR
136136
style RP fill:#f9f,stroke:#333
137137
```
138138

139-
The release-please job includes a commit-message guard that skips execution when the head commit message starts with `chore(main): release`. This prevents an infinite loop where release-please-generated merge commits would re-trigger the release workflow.
139+
Release-please v4 handles `chore`-type commits natively. They are not releasable and do not produce spurious release PRs, so no commit-message guard is needed.
140140

141141
### Main Branch Jobs
142142

143-
| Job | Purpose | Dependencies |
144-
|---------------------------|--------------------------------|--------------------------------------------------|
145-
| spell-check | Post-merge spelling validation | None |
146-
| markdown-lint | Post-merge markdown validation | None |
147-
| table-format | Post-merge table validation | None |
148-
| dependency-pinning-scan | Security pinning check | None |
149-
| pester-tests | PowerShell unit tests | None |
150-
| release-please | Automated release management | All validation jobs (skipped on release commits) |
151-
| extension-package-release | Build release VSIX | release-please (conditional) |
152-
| attest-and-upload | Sign and upload VSIX | extension-package-release |
143+
| Job | Purpose | Dependencies |
144+
|---------------------------|--------------------------------|------------------------------|
145+
| spell-check | Post-merge spelling validation | None |
146+
| markdown-lint | Post-merge markdown validation | None |
147+
| table-format | Post-merge table validation | None |
148+
| dependency-pinning-scan | Security pinning check | None |
149+
| pester-tests | PowerShell unit tests | None |
150+
| release-please | Automated release management | All validation jobs |
151+
| extension-package-release | Build release VSIX | release-please (conditional) |
152+
| attest-and-upload | Sign and upload VSIX | extension-package-release |
153153

154154
When release-please creates a release, the `extension-package-release` job builds the VSIX with the correct version, and `attest-and-upload` signs it with Sigstore attestation before uploading to the GitHub Release.
155155

0 commit comments

Comments
 (0)