Skip to content

chore(docs): workaround for Python 3.14 incompatibility #787

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

chore(docs): workaround for Python 3.14 incompatibility #787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2de0712
chore(deps): update yamale to v6.0.0
pierluigilenoci Nov 19, 2025
5331e4a
Update README to remove compatibility document reference
pierluigilenoci Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ RUN apk --no-cache add \
yamllint

# Install Yamale YAML schema validator
# Note: Yamale 6.0.0 supports Python 3.8+, including Python 3.13.
# Python 3.14 compatibility requires Yamale >= 7.0.0 (when available).
# For Python 3.14 runners, ensure Yamale is updated to a version with Python 3.14 support.
ARG yamale_version=6.0.0
LABEL yamale-version=$yamale_version
RUN pip install --break-system-packages "yamale==$yamale_version"
Expand Down
26 changes: 26 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,21 @@ available tags [here](https://quay.io/repository/helmpack/chart-testing?tab=tags
$ brew install chart-testing
```

## Python Version Compatibility

Chart Testing (`ct`) bundles Yamale for YAML schema validation. The currently bundled Yamale version (6.0.0) supports Python 3.8 through Python 3.13.

**Python 3.14 Note**: If you are using CT on a system with Python 3.14 installed, schema validation may fail due to Yamale's use of deprecated Python AST features that were removed in Python 3.14.

**For detailed information and solutions, see [PYTHON-3.14-COMPATIBILITY.md](PYTHON-3.14-COMPATIBILITY.md)**

**Quick Workaround**: When Python 3.14 is detected on your system:
1. **Use the Docker image** (recommended): `docker run quay.io/helmpack/chart-testing:latest ct lint`
2. **Use Python 3.13 or earlier** on your system or CI/CD pipeline
3. **Disable schema validation** temporarily: `ct lint --validate-chart-schema=false` (not recommended)

Future versions of CT will include updated Yamale versions with Python 3.14 support.

## Usage

See documentation for individual commands:
Expand Down Expand Up @@ -184,6 +199,17 @@ Build ct using Goreleaser.
If this flag is not specified, Goreleaser is run with --snapshot
```

## Troubleshooting

### Schema Validation Fails with Python 3.14

If you encounter `AttributeError: module 'ast' has no attribute 'Num'` or similar errors during schema validation when running CT on a system with Python 3.14, this is a known compatibility issue.

Quick solutions:
- Use the Docker image: `docker run quay.io/helmpack/chart-testing ct lint`
- Use Python 3.13 or earlier
- Upgrade to a future CT release with Python 3.14 support

## Releasing

### Prepare Release
Expand Down