Skip to content

feat: align and enhance GitHub Actions workflows#130

Merged
IdanAdar merged 2 commits intoIBM:mainfrom
Rohit-8541:align-enhance-github-actions
Mar 23, 2026
Merged

feat: align and enhance GitHub Actions workflows#130
IdanAdar merged 2 commits intoIBM:mainfrom
Rohit-8541:align-enhance-github-actions

Conversation

@Rohit-8541
Copy link

Summary

Align and enhance GitHub Actions workflows across all SDKs as per requirements.

Changes Made

✅ Replace bump2version with bump-my-version

  • Updated .releaserc to use bump-my-version with correct syntax
  • Updated create-release.yml workflow to install bump-my-version
  • Migrated .bumpversion.cfg configuration to pyproject.toml
  • Deleted .bumpversion.cfg file

✅ Remove CHANGELOG.md

  • Deleted CHANGELOG.md file
  • Removed @semantic-release/changelog plugin from .releaserc
  • Removed @semantic-release/changelog dependency from package.json
  • Removed Changelog URL from pyproject.toml
  • Release notes now appear only on GitHub releases page

✅ Optimize Workflows

  • Changed checkout fetch-depth from 0 to 1 in all workflows (faster clones)
  • Renamed publish.yaml to publish.yml for consistency
  • Improved workflow structure and step naming
  • Enhanced error handling (fail-fast behavior)

✅ Configure GitHub Releases

  • Configured @semantic-release/github plugin
  • Release notes automatically added to GitHub releases
  • No more CHANGELOG.md maintenance required

Testing

Tested in personal fork: https://github.com/Rohit-8541/secrets-manager-python-sdk

Test Results:

Files Changed (9 files)

  • .bumpversion.cfg - DELETED
  • .github/workflows/codeql-analysis.yml - Updated fetch-depth
  • .github/workflows/create-release.yml - Updated to use bump-my-version
  • .github/workflows/publish.yml - Renamed from .yaml, updated fetch-depth
  • .releaserc - Updated for bump-my-version, removed changelog
  • CHANGELOG.md - DELETED
  • package.json - Removed changelog dependency
  • pyproject.toml - Added bump-my-version config, removed changelog URL
  • ibm_secrets_manager_sdk/version.py - Version sync

Checklist

  • Tested in personal repository
  • All workflows pass
  • No CHANGELOG.md generated
  • Release notes on GitHub releases
  • bump-my-version working correctly
  • Consistent naming across workflows
  • Error handling implemented

@Rohit-8541
Copy link
Author

- Replace bump2version with bump-my-version
- Migrate .bumpversion.cfg to pyproject.toml
- Remove CHANGELOG.md (use GitHub release notes instead)
- Remove @semantic-release/changelog plugin
- Change checkout depth from 0 to 1 in all workflows
- Rename publish.yaml to publish.yml for consistency
- Improve workflow structure and error handling
- Ensure publish only runs on successful release

Signed-off-by: Rohit Kumar <Rohit.Kumar64@ibm.com>
@Rohit-8541 Rohit-8541 force-pushed the align-enhance-github-actions branch from d16ec4b to d6efb36 Compare March 20, 2026 06:37
@Rohit-8541
Copy link
Author

Issue with fetch-depth: 1

After further review and manager feedback, changing fetch-depth from 0 to 1 will cause semantic-release to fail because it needs full git history to:

  • Calculate the next version based on conventional commits
  • Generate release notes from all commits since last release
  • Detect all tags and releases

Recommendation

Revert fetch-depth: 1 back to fetch-depth: 0 in all workflows:

  • .github/workflows/create-release.yml
  • .github/workflows/codeql-analysis.yml
  • .github/workflows/publish.yml

Reference

Manager's feedback: "Strongly recommend either: Revert to fetch-depth: 0"

I will update this PR to fix the fetch-depth issue.

- Changed fetch-depth from 1 to 0 in create-release.yml
- Changed fetch-depth from 1 to 0 in codeql-analysis.yml
- Changed fetch-depth from 1 to 0 in publish.yml
- Ensures semantic-release has full git history for version calculation
- Addresses manager feedback on PR IBM#130

Signed-off-by: Rohit Kumar <Rohit.Kumar64@ibm.com>
@IdanAdar IdanAdar merged commit c366489 into IBM:main Mar 23, 2026
3 checks passed
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