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.0.0 DOCS-674 #2143

Merged
merged 15 commits into from
Jun 26, 2024

Conversation

Ngwerume
Copy link
Contributor

@Ngwerume Ngwerume commented Jun 20, 2024

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

👀 Live preview

https://feat-release-notes-self-hosted-14-0--docs-codacy.netlify.app/release-notes/self-hosted/self-hosted-v14.0.0/

🚧 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
  • Not required 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 Jun 20, 2024

Overall readability score: 54 (🟢 +0.05)

File Readability
index.md 72.67 (🔴 -0.16)
self-hosted-v12.0.0.md 53.37 (🔴 -0.08)
self-hosted-v13.0.0.md 51.28 (🟢 +0)
self-hosted-v14.0.0.md 65.05 (-)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
index.md 72.67 87.55 9.18 13 9.63 6.31
  🔴 -0.16 🔴 -0.21 🔴 -0.05 🔴 -0.1 🟢 +0.05 🟢 +0.01
self-hosted-v12.0.0.md 53.37 45.12 8.83 13.3 14.7 7.96
  🔴 -0.08 🟢 +0 🟢 +0 🟢 +0 🔴 -0.06 🟢 +0
self-hosted-v13.0.0.md 51.28 50.23 9.13 14.9 15.7 7.55
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
self-hosted-v14.0.0.md 65.05 71 7.28 12.4 12.9 7.68
  - - - - - -

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54 43.06 10.8 12.49 12.57 7.91
  🟢 +0.05 🟢 +0.14 🟢 +0.02 🟢 +0 🟢 +0 🟢 +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 June 20, 2024 09:18 Inactive
@nicklem nicklem self-assigned this Jun 20, 2024
@nicklem nicklem changed the title feat: Release notes for Codacy Self-hosted 14.0.0 feat: Release notes for Codacy Self-hosted 14.0.0 DOCS-674 Jun 20, 2024
@github-actions github-actions bot temporarily deployed to Netlify June 20, 2024 13:06 Inactive
@github-actions github-actions bot temporarily deployed to Netlify June 21, 2024 14:06 Inactive
@github-actions github-actions bot temporarily deployed to Netlify June 21, 2024 14:49 Inactive
@github-actions github-actions bot temporarily deployed to Netlify June 21, 2024 14:50 Inactive
@nicklem nicklem requested a review from heliocodacy June 21, 2024 15:17
@nicklem nicklem marked this pull request as ready for review June 21, 2024 15:18
@nicklem nicklem requested review from a team as code owners June 21, 2024 15:18
@github-actions github-actions bot temporarily deployed to Netlify June 21, 2024 15:18 Inactive
@github-actions github-actions bot temporarily deployed to Netlify June 25, 2024 11:54 Inactive
@github-actions github-actions bot temporarily deployed to Netlify June 26, 2024 08:23 Inactive
@github-actions github-actions bot temporarily deployed to Netlify June 26, 2024 08:25 Inactive
@nicklem nicklem force-pushed the feat/release-notes-self-hosted-14.0.0 branch from 56c6d73 to 6df13b8 Compare June 26, 2024 08:36
@github-actions github-actions bot temporarily deployed to Netlify June 26, 2024 08:37 Inactive
Copy link
Contributor

@claudiacarpinteiro claudiacarpinteiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 👍

@github-actions github-actions bot temporarily deployed to Netlify June 26, 2024 10:02 Inactive
@nicklem nicklem merged commit 5306939 into master Jun 26, 2024
6 checks passed
@nicklem nicklem deleted the feat/release-notes-self-hosted-14.0.0 branch June 26, 2024 10:05
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.

4 participants