Skip to content
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.

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

feat: Release notes for Codacy Self-hosted 14.1.1 #2363

Merged
merged 3 commits into from
Mar 10, 2025

Conversation

DMarinhoCodacy
Copy link
Contributor

Adds auto-generated release notes for Codacy Self-hosted 14.1.1

👀 Live preview

https://feat-release-notes-self-hosted-14-1--docs-codacy.netlify.app/release-notes/cloud/cloud-v14.1.1/

🚧 To do

  • Update the variable extra.codacy_self_hosted_version in mkdocs.yml to the new Codacy Self-hosted version
  • Add the new release notes page to mkdocs.yml and docs/release-notes/index.md
  • Add the breaking changes section if the release is a new major version
  • Review generated release notes
  • Review list of issues with missing release notes
  • Ensure that links point to documentation for new Codacy Self-hosted version
  • Review links to changelogs of updated tools
  • Update the CLI tool versions and update the variable extra.codacy_coverage_reporter_version in mkdocs.yml
  • Update release date and remove TODO comments

Copy link
Contributor

github-actions bot commented Mar 10, 2025

Overall readability score: 53.25 (🟢 +0.01)

File Readability
index.md 72.75 (🔴 -0.18)
self-hosted-v14.1.1.md 55.6 (-)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
index.md 72.75 87.15 9.2 13.1 9.63 6.21
  🔴 -0.18 🔴 -0.2 🔴 -0.06 🔴 -0.1 🟢 +0.05 🟢 +0.01
self-hosted-v14.1.1.md 55.6 51.95 8.4 12.5 14.31 8.38
  - - - - - -

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.25 42.76 10.87 12.64 12.7 7.96
  🟢 +0.01 🟢 +0.04 🟢 +0.01 🟢 +0 🔴 -0.01 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@github-actions github-actions bot temporarily deployed to Netlify March 10, 2025 15:47 Inactive
@github-actions github-actions bot temporarily deployed to Netlify March 10, 2025 16:06 Inactive
@DMarinhoCodacy DMarinhoCodacy marked this pull request as ready for review March 10, 2025 16:10
@DMarinhoCodacy DMarinhoCodacy requested review from a team as code owners March 10, 2025 16:10
@github-actions github-actions bot temporarily deployed to Netlify March 10, 2025 16:11 Inactive
@DMarinhoCodacy DMarinhoCodacy merged commit 2bd6bcf into master Mar 10, 2025
6 checks passed
@DMarinhoCodacy DMarinhoCodacy deleted the feat/release-notes-self-hosted-14.1.1 branch March 10, 2025 16:28
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.

3 participants