Skip to content

ci: fix merge commit validation and document release environment setup - #2220

Merged
butler54 merged 1 commit into
v3from
ci/cherry-pick-merge-commit-fix-v3
May 11, 2026
Merged

ci: fix merge commit validation and document release environment setup#2220
butler54 merged 1 commit into
v3from
ci/cherry-pick-merge-commit-fix-v3

Conversation

@butler54

@butler54 butler54 commented May 8, 2026

Copy link
Copy Markdown
Collaborator

Summary

Cherry-pick of #2218 from develop to the v3 maintenance branch.

This PR addresses two maintenance branch release process issues discovered during v3 branch CI failures:

  1. Fixes merge commit validation failure: The "Validate commit types on maintenance branch" step now excludes merge commits by adding --no-merges to the git log command. GitHub's auto-generated merge commit messages (e.g., Merge pull request #2217 from ...) don't follow conventional commit format, but semantic-release already ignores them (default_bump_level = 0), so the validation was unnecessarily strict and caused false failures.

  2. Documents release environment setup: Expanded docs/contributing/github_actions_setup.md with explicit step-by-step instructions (both UI and CLI) for adding maintenance branches to the release environment. Emphasizes adding each branch individually (e.g., v3, v4) rather than using wildcards, to require deliberate opt-in for new maintenance branches. Updated docs/contributing/maintenance_releases.md to cross-reference the detailed instructions.

  3. Adds Snyk exception: Includes exception for SNYK-PYTHON-PARAMIKO-16425764, a low severity cryptographic algorithm vulnerability in paramiko@4.0.0 with no available upgrade or patch.

Changes

  • .github/workflows/python-push.yml: Added --no-merges flag to git log in commit type validation step
  • docs/contributing/github_actions_setup.md: New section with detailed release environment configuration instructions
  • docs/contributing/maintenance_releases.md: Updated step 4 to reference the expanded instructions
  • .snyk: Added exception for paramiko vulnerability

Verification

  • Cherry-pick applied cleanly with auto-merge
  • Changes match develop branch version

Related Issues

Resolves the CI failure observed in https://github.com/oscal-compass/compliance-trestle/actions/runs/25378701232/job/74753750952

🤖 Generated with Claude Code

#2218)

* ci: fix merge commit validation and document release environment setup

This commit addresses two maintenance branch release process issues:

1. The commit type validation step now excludes merge commits by adding
   `--no-merges` to the git log command. GitHub's auto-generated merge
   commit messages (e.g. "Merge pull request #NNN") don't follow
   conventional commit format, but semantic-release already ignores
   them (default_bump_level = 0), so validating them is unnecessary
   and causes false failures.

2. Expanded documentation in github_actions_setup.md with explicit
   step-by-step instructions for adding maintenance branches to the
   release environment, emphasizing individual branch names over
   wildcards to require deliberate opt-in. Updated maintenance_releases.md
   to cross-reference the detailed instructions.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Signed-off-by: Chris Butler <chris.butler@redhat.com>

* ci: add Snyk exception for paramiko cryptographic algorithm issue

Add exception for SNYK-PYTHON-PARAMIKO-16425764, a low severity
cryptographic algorithm vulnerability in paramiko@4.0.0. No upgrade
or patch is currently available. Paramiko is used for remote SSH
operations which are not part of trestle's primary use case.

The exception expires in 3 months to prompt re-evaluation when
upstream fixes become available.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Signed-off-by: Chris Butler <chris.butler@redhat.com>

---------

Signed-off-by: Chris Butler <chris.butler@redhat.com>
Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
@butler54
butler54 requested a review from a team as a code owner May 8, 2026 00:36

@degenaro degenaro left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@butler54
butler54 merged commit 1d6a191 into v3 May 11, 2026
15 of 16 checks passed
@butler54
butler54 deleted the ci/cherry-pick-merge-commit-fix-v3 branch May 11, 2026 11:22
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