You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: show Codacy Self-hosted facts per version on the chart pages [OD-1044] - #2800
With one unversioned site, the Self-hosted section has to say what each supported version has and needs. This PR uses the version data from #2799 across the chart pages, adds a page listing what's on Self-hosted, and brings in the six Self-hosted-only pages that existed only in the frozen /v14.0/ build. Part of P-OD-602 / OD-1044.
New pages
chart/whats-available-on-codacy-self-hosted.md, from the approved feature list in OD-1044: what's available (linked to the Cloud pages that apply), what's different, and what's only on Codacy Cloud. Codacy CLI v2 is Cloud-only: it hard-codes https://app.codacy.com (codacy-cli-v2 @5cc84de, codacy-client/client.go:17).
chart/using-codacy/, copied from release/v14.0 @49a7c7f with their images: Adjusting quality settings, Configuring file extensions, Security Monitor, and the repository-level Jira, Slack, and webhook notifications. Links are fixed for the new folder. The "paid plans" notice is removed from Security Monitor, since Self-hosted is licensed.
Both are in the nav under Managing Codacy Self-hosted.
Per-version facts
chart/index.md: a supported-versions statement and the full self_hosted_table().
chart/requirements.md: Kubernetes, MicroK8s, and PostgreSQL versions come from the data file instead of hard-coded text.
Kubernetes for v15.0.0 and v16.0.0 now follows the release notes, checked against the chart CI at each tag:
v15.0.0: 1.22 to 1.27, and 1.30 (CI installs on 1.19–1.27 and 1.30).
v16.0.0: 1.30 to 1.33 (CI installs on 1.30–1.33 only; codacy/chart 0a1a1cd removed the older jobs).
Helm commands
The 13 configuration commands (integrations, caching, monitoring, logging, license) now show one tab per version. Before, every page said --version 15.0.0, so a v14 customer reconfiguring would upgrade by accident. The tabs are linked, so picking a version once selects it across the site.
Install and upgrade use self_hosted_latest.version (17.0.0) instead of the stale extra.codacy_self_hosted_version (15.0.0). The values-file links resolve at tag 16.0.0.
The upgrade page's tool links were broken: the self-hosted-X tags on the tool repos stop at 11.0.0. They now point to the versions in the data file (Analysis CLI 7.9.5, Coverage Reporter 13.10.15), and both releases exist.
Vale: each helm template sits in a fenced block inside {% set command %}, so Vale reads it as code, and endset is in the Codacy vocabulary.
self_hosted_tabs() takes indent, so it can sit inside a numbered step. Documented in .claude/reference/formatting.md.
v17.0.0 as the latest version
Release noteself-hosted-v17.0.0.md, registered in release-notes/index.md and the nav. The codacy chart 17.0.0 has been on the stable channel since 2026-09-02, but no note was written.
No component changes: requirements.lock matches 16.0.0 apart from its timestamp, and codacy-tools-sh stays at 1.2.21, so the tool list is the same.
TODO: verify: codacy/values.yaml changes the default RabbitMQ tag from 3.8.35-debian-11-r5 to 3.8.5. Does that need an upgrade note?
Data row for v17.0.0: Kubernetes 1.30 to 1.33 (the chart CI install jobs at 17.0.0), the same tools as v16. Install, upgrade, and the first version tab now use 17.0.0; the values-file links resolve at that tag.
Still to verify
MicroK8s for v16.0.0 and v17.0.0 is set to 1.30 to 1.33, the range the chart CI install jobs run on. The MicroK8s quickstart still installs from the 1.19/stable channel; chart owners, please confirm whether it should move to 1.33.
extra.codacy_self_hosted_version is no longer used under docs/chart/; removing it everywhere is OD-1038.
Verification
mkdocs build --strict passes.
Built HTML checked: each configuration command renders 8 version tabs inside its numbered step, with no unrendered template text. Not checked visually in a browser.
Vale: only false positives on macro arguments and existing URL lines.
👀 Live preview
🚧 To do
If relevant, include the Jira issue key at the end of the pull request title
…D-1044]
- Add "What's available on Codacy Self-hosted" from the approved feature list.
- Bring the six Self-hosted-only pages from release/v14.0 into chart/using-codacy/.
- Render Kubernetes, MicroK8s, and PostgreSQL requirements from the version data.
- Kubernetes for v15.0.0 and v16.0.0 follows the release notes, checked against chart CI.
- Configuration helm commands get one tab per version; install and upgrade use the latest.
- Fix the upgrade page's tool links: the self-hosted-X tags stop at 11.0.0.
- self_hosted_tabs() takes an indent, so it can sit inside a list item.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
⚠️Resolve issues before merging
Two blocking documentation correctness issues remain: the published MicroK8s requirement contradicts the evidence in the same data file, and the Security Monitor page contains malformed table markup. These should be corrected before merging.
The strict documentation build and version-aware rendering scenarios have not been automated or otherwise demonstrated in the supplied review data, leaving the acceptance criteria around generated output and selected-version commands unverified.
Test suggestions
Build the documentation strictly and verify all version macros, tables, and tabs render without unresolved template text.
Test self_hosted_tabs indentation inside numbered lists and verify tab groups remain correctly structured.
Verify self_hosted_table renders every supported version and requested field in the expected order.
Verify installation, upgrade, and configuration commands use the intended latest or selected Self-hosted version.
Validate the HTML structure of the newly added Security Monitor page.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Build the documentation strictly and verify all version macros, tables, and tabs render without unresolved template text.
2. Test self_hosted_tabs indentation inside numbered lists and verify tab groups remain correctly structured.
3. Verify self_hosted_table renders every supported version and requested field in the expected order.
4. Verify installation, upgrade, and configuration commands use the intended latest or selected Self-hosted version.
5. Validate the HTML structure of the newly added Security Monitor page.
Low confidence findings
Add automated documentation-build and rendering checks for the new version-aware macros and templates.
- Release note for v17.0.0 (stable chart published 2026-09-02), registered in the
index and nav. No component changes from v16.0.0; one upgrade-hook fix.
- Data row for v17.0.0, so install, upgrade, and the version tabs use it.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… MicroK8s for v16+ [OD-1044]
- Helm templates sit in a fenced block inside {% set command %}, so Vale reads them as
code; add "endset" to the Codacy vocabulary. Document the pattern in formatting.md.
- v17.0.0 note: drop the unused codacy_tools_version_* keys, format @coffeelint/cli as code.
- Security Monitor (copied from v14): add the missing <tr> before PHP, drop a stray </a>
in the C++ row, close the footnote <span>.
- MicroK8s for v16.0.0 and v17.0.0 is 1.30 to 1.33, the range the chart CI installs on.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…044]
The page references three status images and the Code patterns page from raw HTML,
which the copy from release/v14.0 didn't carry over or re-base. htmltest flagged all four.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
![codacy-production[bot]](https://avatars.githubusercontent.com/in/56611?s=60&v=4){kind=small}
With one unversioned site, the Self-hosted section has to say what each supported version has and needs. This PR uses the version data from #2799 across the chart pages, adds a page listing what's on Self-hosted, and brings in the six Self-hosted-only pages that existed only in the frozen
/v14.0/build. Part of P-OD-602 / OD-1044.New pages
chart/whats-available-on-codacy-self-hosted.md, from the approved feature list in OD-1044: what's available (linked to the Cloud pages that apply), what's different, and what's only on Codacy Cloud. Codacy CLI v2 is Cloud-only: it hard-codeshttps://app.codacy.com(codacy-cli-v2@5cc84de,codacy-client/client.go:17).chart/using-codacy/, copied fromrelease/v14.0@49a7c7f with their images: Adjusting quality settings, Configuring file extensions, Security Monitor, and the repository-level Jira, Slack, and webhook notifications. Links are fixed for the new folder. The "paid plans" notice is removed from Security Monitor, since Self-hosted is licensed.Per-version facts
chart/index.md: a supported-versions statement and the fullself_hosted_table().chart/requirements.md: Kubernetes, MicroK8s, and PostgreSQL versions come from the data file instead of hard-coded text.1.22 to 1.27, and 1.30(CI installs on 1.19–1.27 and 1.30).1.30 to 1.33(CI installs on 1.30–1.33 only;codacy/chart0a1a1cd removed the older jobs).Helm commands
--version 15.0.0, so a v14 customer reconfiguring would upgrade by accident. The tabs are linked, so picking a version once selects it across the site.self_hosted_latest.version(17.0.0) instead of the staleextra.codacy_self_hosted_version(15.0.0). The values-file links resolve at tag 16.0.0.self-hosted-Xtags on the tool repos stop at 11.0.0. They now point to the versions in the data file (Analysis CLI 7.9.5, Coverage Reporter 13.10.15), and both releases exist.{% set command %}, so Vale reads it as code, andendsetis in the Codacy vocabulary.self_hosted_tabs()takesindent, so it can sit inside a numbered step. Documented in.claude/reference/formatting.md.v17.0.0 as the latest version
self-hosted-v17.0.0.md, registered inrelease-notes/index.mdand the nav. Thecodacychart 17.0.0 has been on the stable channel since 2026-09-02, but no note was written.requirements.lockmatches 16.0.0 apart from its timestamp, andcodacy-tools-shstays at 1.2.21, so the tool list is the same.BackoffLimitExceededin the log-retention hook job (codacy/chartfix: Update latest chart version #839–fix: Add note for bulk copy of patterns in Self-hosted 4.2.0 #843).TODO: verify:codacy/values.yamlchanges the default RabbitMQ tag from3.8.35-debian-11-r5to3.8.5. Does that need an upgrade note?Still to verify
1.19/stablechannel; chart owners, please confirm whether it should move to 1.33.extra.codacy_self_hosted_versionis no longer used underdocs/chart/; removing it everywhere is OD-1038.Verification
mkdocs build --strictpasses.👀 Live preview
🚧 To do
🤖 Generated with Claude Code