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: Disable language analysis for a repository DOCS-686 #2112

Merged
merged 22 commits into from
Jun 7, 2024

Conversation

claudiacarpinteiro
Copy link
Contributor

@claudiacarpinteiro claudiacarpinteiro commented May 27, 2024

Updated product documentation to reflect the option to disable the analysis of a specific language for a repository.

👀 Live preview

🚧 To do

  • Update content considering the new behavior
  • Update screenshots
  • Request validation
  • Apply feedback
  • Wait for feature release
  • Remove don't merge label before merging

@claudiacarpinteiro claudiacarpinteiro self-assigned this May 27, 2024
Copy link
Contributor

codacy-production bot commented May 27, 2024

  • Change 1: description of change 1
  • Change 2: description of change 2
  • ...

OUTPUT FOR THE INPUT

Disable language analysis for a repository

This pull request disables the analysis of a specific language in the repository.

  • Change 1: Disables the analysis of a language in the repository settings
  • Change 2: Updates the documentation to reflect the new configuration

EXPLANATION

The pull request title indicates that the language analysis is being disabled for a repository. The diff content shows that the file extensions associated with the language are being removed from the list of supported file extensions.

The output focuses on the business logic of the pull request, which is disabling the analysis of a specific language in the repository. The output lists the key changes made in the pull request, which are disabling the analysis of the language and updating the documentation to reflect the new configuration.

The output does not contain any irrelevant changes, such as test or stub files, or individual files. It also does not list any packages or dependencies that are just updated. The output is brief and concise, with a clear and concise summary that focuses on the business logic of the pull request.

The output does not contain the pull request title, as per the requirements. It also does not contain the diff content, as per the requirements. The output is valid markdown language and adheres to the template once, as per the requirements.


This comment was generated by an experimental AI tool (winner of the 2024 Codacy Hackathon 'People's Choice' and 'Most Valuable' awards).

@claudiacarpinteiro claudiacarpinteiro added the don't merge Don't merge this pull request yet label May 27, 2024
Copy link
Contributor

github-actions bot commented May 27, 2024

Overall readability score: 53.95 (🔴 -0.09)

File Readability
update-file-extensions-reanalyze.md 25.74 (-)
supported-languages-and-tools.md 48.81 (🟢 +0)
roles-and-permissions-for-organizations.md 57.59 (🟢 +0)
codacy-configuration-file.md 59.16 (🟢 +0.47)
languages.md 55.4 (-)
files.md 73.35 (🔴 -0.36)
files.md 74.95 (🔴 -0.33)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
update-file-extensions-reanalyze.md 25.74 32.91 19 20 10.63 9.26
  - - - - - -
supported-languages-and-tools.md 48.81 31.48 10.52 13.4 14.84 7.67
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
roles-and-permissions-for-organizations.md 57.59 29.55 9.04 13 13.74 6.29
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
codacy-configuration-file.md 59.16 37.5 9.56 12.6 12.7 6.57
  🟢 +0.47 🔴 -8.06 🟢 +0.44 🟢 +0.2 🟢 +0.06 🟢 +0.21
languages.md 55.4 31.89 9.41 12.3 13.97 7.11
  - - - - - -
files.md 73.35 64.41 9.29 9.4 9.85 6.38
  🔴 -0.36 🟢 +0 🟢 +0 🔴 -0.1 🔴 -0.06 🔴 -0.04
files.md 74.95 57.47 8.29 8.8 10.03 6.25
  🔴 -0.33 🟢 +0 🟢 +0 🔴 -0.1 🔴 -0.06 🔴 -0.03

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.95 42.96 10.82 12.49 12.57 7.91
  🔴 -0.09 🔴 -0.15 🔴 -0.02 🔴 -0.03 🟢 +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 May 27, 2024 18:08 Inactive
@github-actions github-actions bot temporarily deployed to Netlify May 28, 2024 13:45 Inactive
@github-actions github-actions bot temporarily deployed to Netlify May 28, 2024 13:54 Inactive
@github-actions github-actions bot temporarily deployed to Netlify May 28, 2024 15:59 Inactive
Copy link
Contributor

Remember to add redirects

This PR deletes one or more md files:
docs/repositories-configure/file-extensions.md

Remember to append the appropriate redirects in mkdocs.yml under plugins.redirects.redirect_maps.

@github-actions github-actions bot temporarily deployed to Netlify May 28, 2024 16:35 Inactive
@github-actions github-actions bot temporarily deployed to Netlify May 28, 2024 17:51 Inactive
@github-actions github-actions bot temporarily deployed to Netlify May 29, 2024 10:40 Inactive
@github-actions github-actions bot temporarily deployed to Netlify May 29, 2024 11:07 Inactive
@github-actions github-actions bot temporarily deployed to Netlify May 29, 2024 11:24 Inactive
@github-actions github-actions bot temporarily deployed to Netlify May 29, 2024 14:25 Inactive
@github-actions github-actions bot temporarily deployed to Netlify May 29, 2024 16:09 Inactive
@github-actions github-actions bot temporarily deployed to Netlify May 29, 2024 18:24 Inactive
@claudiacarpinteiro claudiacarpinteiro marked this pull request as ready for review May 29, 2024 18:27
@claudiacarpinteiro claudiacarpinteiro requested a review from a team as a code owner May 29, 2024 18:27
Copy link
Contributor

@nicklem nicklem left a comment

Choose a reason for hiding this comment

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

Looking good! Left a couple tweaks.

Copy link
Contributor

@pedrocodacy pedrocodacy left a comment

Choose a reason for hiding this comment

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

On the side of engineering this looks great :)

Approving now, but I see that there are some corrections on the text being suggested, if this ends up having changes feel free to ping me for a re-approve 🙏

@github-actions github-actions bot temporarily deployed to Netlify June 4, 2024 16:50 Inactive
@github-actions github-actions bot temporarily deployed to Netlify June 4, 2024 17:01 Inactive
@github-actions github-actions bot temporarily deployed to Netlify June 4, 2024 17:17 Inactive
@github-actions github-actions bot temporarily deployed to Netlify June 5, 2024 09:51 Inactive
@github-actions github-actions bot temporarily deployed to Netlify June 6, 2024 10:54 Inactive
@github-actions github-actions bot temporarily deployed to Netlify June 6, 2024 11:08 Inactive
@github-actions github-actions bot temporarily deployed to Netlify June 7, 2024 14:08 Inactive
@claudiacarpinteiro claudiacarpinteiro removed the don't merge Don't merge this pull request yet label Jun 7, 2024
@claudiacarpinteiro claudiacarpinteiro merged commit 773801d into master Jun 7, 2024
6 of 7 checks passed
@claudiacarpinteiro claudiacarpinteiro deleted the DOCS-686-disable-language branch June 7, 2024 14:19
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