Skip to content

Update documentation and CI workflow#15

Merged
Artemonim merged 6 commits intodevfrom
cicd-enchance
Jul 7, 2025
Merged

Update documentation and CI workflow#15
Artemonim merged 6 commits intodevfrom
cicd-enchance

Conversation

@Artemonim
Copy link
Owner

@Artemonim Artemonim commented Jul 7, 2025

Documentation

  • Contribution Guide: Added a new CONTRIBUTING.md file with detailed guidelines for development workflow and the release process.
  • README Update: Updated README.md to link to the new contribution guide and reflect the automated release process.

CI/CD

  • Release Automation: Added a new release-automation.yml workflow that automatically creates Git tags, GitHub Releases, and back-merge PRs when release branches are merged to master.
  • CI Optimization: Optimized the main CI pipeline by removing redundant test runs on master branch pushes and adding caching for pip dependencies and Go modules to speed up workflow execution.
  • Workflow Efficiency: Changed CI triggers to run on pushes to dev instead of master, eliminating duplicate test runs while maintaining comprehensive coverage.
  • Version Check Precision: Improved the version bump detection in CI to specifically check version changes in pyproject.toml and agent_docstrings/__init__.py, preventing false positives from other file modifications.

Type of Change

  • 🐛 Bug Fix: A change that fixes an issue.
  • New Feature: A change that adds new functionality.
  • ♻️ Refactor: A code change that neither fixes a bug nor adds a feature.
  • 📚 Documentation: Changes to the documentation only.
  • ⚙️ CI/CD: Changes to our CI/CD configuration and scripts.
  • 🔨 Build: Changes that affect the build system or external dependencies.
  • 🎨 Style: Changes that do not affect the meaning of the code (white-space, formatting, etc.).
  • Revert: Reverts a previous commit.

Artemonim added 5 commits July 7, 2025 15:15
### Changed
- Modified the CI workflow to trigger tests on pushes to the `dev` branch instead of `master`.
- Added caching for Go modules and pip dependencies in the CI workflow to improve build performance.
- Introduced a new release automation workflow that creates a GitHub release upon merging pull requests from `release/*` branches into `master`, extracts version information, and generates changelog notes.
- Implemented a back-merge PR to sync `master` back into `dev` after a release.
### Added
- Introduced a `CONTRIBUTING.md` file with comprehensive guidelines for contributing to the project.
- Updated `README.md` to link to the new contribution guide and clarify the automated release process.
- Implemented a new `release-automation.yml` workflow for automatic Git tagging, GitHub Releases, and back-merging PRs upon merging release branches into master.
- Optimized the CI pipeline by removing redundant test runs on master branch pushes and adding caching for pip dependencies and Go modules.

### Changed
- Adjusted CI triggers to run on pushes to `dev` instead of `master`, improving workflow efficiency.
### Changed
- Enhanced the `CONTRIBUTING.md` file to include instructions for linking issues in the changelog entries.
- Streamlined the `.github/PULL_REQUEST_TEMPLATE.md` by removing unnecessary sections and clarifying the checklist items for contributors.

### Added
- Included a Contribution Guide link and a reminder for contributors to update the `CHANGELOG.md` under the `[NextRelease]` section in the pull request template.
@Artemonim Artemonim marked this pull request as ready for review July 7, 2025 21:41
@Artemonim Artemonim merged commit 891f8f9 into dev Jul 7, 2025
10 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.

1 participant