CodeCharter publishes through two parallel distribution channels.
Stable
Verified releases approved for production use.
- Version format: SemVer (
1.4.0,1.5.0,2.0.0). - Contractual guarantee: no breaking changes within a major version, see Versioning.
Recommendation for your CI: pin to a specific Stable version and plan updates deliberately.
Edge
Early pre-release versions for internal builds and early adopters who want to test new features ahead of time and send us bug reports.
- Version format: with suffix, for example
1.5.0-edge.3. - Recommended use: developers locally or an optional pre-production CI job.
Switching between channels
Manual pull:
# Stable, latest version
curl ... /api/v1/cli/linux-x64/latest
# Specific Edge version
curl ... /api/v1/cli/linux-x64/1.5.0-edge.3
GitHub Action: the version input accepts a specific version number. The default is always the latest Stable.
- uses: bochmann-software/codeguard@v1
with:
version: 1.4.0
api-key: ${{ secrets.CODECHARTER_API_KEY }}
Channel by use case
| Scenario | Channel |
|---|---|
Production CI on main |
Stable |
| PR CI with full strictness | Stable |
| Developers locally, mainstream | Stable |
| Developers locally, early adopters | Edge |
| Dedicated beta test job in CI | Edge |
Running multiple channels simultaneously
Developers on Edge locally and CI on Stable works without any issues. In the PR diff, developers see findings early that Stable will also detect soon. Once the Stable version catches up, CI is automatically at the same level.
Notifications
When a new Stable release ships, we send an email to all active subscriptions. The full Changelog is available in the wiki.