Contributing to Container & Helm Version Updater

September 4, 2026 · View on GitHub

Thank you for your interest in contributing! This document provides guidelines and instructions for contributing.

Development Setup

Local Setup

Clone the repository:

git clone https://github.com/drumandbytes/argocd-gitops-updater-action.git
cd argocd-gitops-updater-action

Install dependencies:

pip install aiohttp aiofiles pyyaml packaging pytest pytest-asyncio ruff

Run tests:
```
pytest tests/ -v
```

Run linting:

ruff check .github/scripts/
ruff format --check .github/scripts/

Project Structure

.
├── action.yml                    # GitHub Action definition
├── .github/
│   ├── scripts/
│   │   ├── update-versions.py    # Core version update logic
│   │   └── discover-resources.py # Auto-discovery logic
│   └── workflows/
│       └── ci.yml                # CI pipeline
├── tests/                        # Unit tests
├── examples/                     # Example configurations
└── README.md                     # User documentation

Making Changes

Code Style

Follow PEP 8 guidelines
Use type hints for function parameters and return values
Keep functions focused and well-documented
Use async/await for I/O operations

Testing

Add tests for new functionality
Ensure all existing tests pass
Test edge cases and error conditions

Run tests with:

pytest tests/ -v

Linting

We use Ruff for linting and formatting:

# Check for issues
ruff check .github/scripts/

# Auto-fix issues
ruff check --fix .github/scripts/

# Check formatting
ruff format --check .github/scripts/

# Auto-format
ruff format .github/scripts/

Submitting Changes

Pull Request Process

Fork the repository
Create a feature branch: git checkout -b feature/my-feature
Make your changes
Run tests and linting
Commit with a clear message: git commit -m "feat: add new feature"
Push to your fork: git push origin feature/my-feature
Open a Pull Request

Releases are automated with release-please. It reads the commit history on main, keeps a rolling release PR with the next version + changelog, and cuts the release (tag, GitHub Release, CHANGELOG.md) when that PR is merged. The floating v2 / v2.N tags are moved automatically.

For this to work, squash-merge every PR with a Conventional Commits title:

Prefix	Effect	Example
`feat:`	minor bump	`feat: add support for Azure Container Registry`
`fix:` / `perf:`	patch bump	`fix: handle timeout errors in the Docker Hub API`
`feat!:` or `BREAKING CHANGE:` in body	major bump	`feat!: require ArgoCD 2.x`
`chore:` `docs:` `ci:` `test:` `refactor:` `build:`	no release	`docs: update the README`

Dependabot is configured to prefix its PRs with fix(deps):, so dependency bumps become patch releases on their own.

The old release:major / release:minor / release:patch labels are gone. Don't hand-edit CHANGELOG.md, version.txt, or tags — release-please owns them.