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: Dedicated release note for dropping repository permissions for Administration on GitHub #1971

Merged
merged 57 commits into from
Jan 15, 2024

Conversation

claudiacarpinteiro
Copy link
Contributor

@claudiacarpinteiro claudiacarpinteiro commented Dec 6, 2023

Adds a dedicated release note page explaining that Codacy GitHub App no longer requests read and write repository permissions for Administration and what users need to do.

👀 Live preview

https://pluto-802-gh-access-tokens-release--docs-codacy.netlify.app/release-notes/cloud/cloud-2024-01-15-gh-repository-ssh-keys-discontinuation/

🚧 To do

  • Request validation
  • Apply feedback
  • Wait for communication date

Copy link
Contributor

github-actions bot commented Dec 6, 2023

Overall readability score: 54.2 (🔴 -0.05)

File Readability
which-permissions-does-codacy-need-from-my-account.md 57.15 (🟢 +0.14)
cloud-2024-01-15-gh-repository-ssh-keys-discontinuation.md 46.42 (-)
index.md 72.83 (🔴 -2.92)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
which-permissions-does-codacy-need-from-my-account.md 57.15 35.98 10.72 12 11.95 7.1
  🟢 +0.14 🟢 +0.3 🟢 +0.12 🟢 +0 🔴 -0.17 🟢 +0.04
cloud-2024-01-15-gh-repository-ssh-keys-discontinuation.md 46.42 26.91 11.26 14.3 14.33 7.6
  - - - - - -
index.md 72.83 87.76 9.13 12.9 9.68 6.32
  🔴 -2.92 🔴 -8.96 🔴 -0.35 🔴 -0.3 🔴 -0.17 🔴 -0.05

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.2 42.97 10.86 12.38 12.54 7.87
  🔴 -0.05 🔴 -0.13 🟢 +0 🔴 -0.01 🔴 -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

@claudiacarpinteiro claudiacarpinteiro self-assigned this Dec 6, 2023
@claudiacarpinteiro claudiacarpinteiro added the don't merge Don't merge this pull request yet label Dec 6, 2023
@github-actions github-actions bot temporarily deployed to Netlify December 6, 2023 16:51 Inactive
@github-actions github-actions bot temporarily deployed to Netlify December 7, 2023 18:41 Inactive
@github-actions github-actions bot temporarily deployed to Netlify December 11, 2023 16:05 Inactive
@github-actions github-actions bot temporarily deployed to Netlify December 11, 2023 16:33 Inactive
Copy link
Contributor

@RaquelHipolito RaquelHipolito left a comment

Choose a reason for hiding this comment

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

@claudiacarpinteiro I left some suggestions, feel free to action what makes sense.
One general thought, there's no mention of who can action the change requested - admin, everyone, etc?

@claudiacarpinteiro
Copy link
Contributor Author

@claudiacarpinteiro I left some suggestions, feel free to action what makes sense.

Thank you for the feedback, @RaquelHipolito! I updated accordingly. 👍

One general thought, there's no mention of who can action the change requested - admin, everyone, etc?

Good question! 🤔
@andrzej-janczak @lorandszakacs Maybe you can help here... Which role must approve Codacy GitHub App updated permissions? Must all users perform this action, or only Organization owners?

@github-actions github-actions bot temporarily deployed to Netlify December 12, 2023 17:55 Inactive
@andrzej-janczak
Copy link
Contributor

#1971 (comment)
Only Admin can accept new permissions

@andrzej-janczak
Copy link
Contributor

looks great 💯

@github-actions github-actions bot temporarily deployed to Netlify December 13, 2023 12:06 Inactive
@github-actions github-actions bot temporarily deployed to Netlify December 13, 2023 12:17 Inactive
@github-actions github-actions bot temporarily deployed to Netlify January 11, 2024 17:52 Inactive
Copy link
Contributor

@jorgebraz jorgebraz left a comment

Choose a reason for hiding this comment

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

In general looks good to me, all my feedback is related to "present" VS "future" and what the semantics words like "deprecated".
Let me know if the comments were clear or let's sync and commit.

@github-actions github-actions bot temporarily deployed to Netlify January 12, 2024 16:12 Inactive
@github-actions github-actions bot temporarily deployed to Netlify January 12, 2024 16:15 Inactive
@github-actions github-actions bot temporarily deployed to Netlify January 12, 2024 16:27 Inactive
@github-actions github-actions bot temporarily deployed to Netlify January 12, 2024 16:33 Inactive
@github-actions github-actions bot temporarily deployed to Netlify January 12, 2024 16:45 Inactive
@github-actions github-actions bot temporarily deployed to Netlify January 12, 2024 17:03 Inactive
@github-actions github-actions bot temporarily deployed to Netlify January 12, 2024 17:19 Inactive
@claudiacarpinteiro
Copy link
Contributor Author

@jorgebraz @andrzej-janczak Thank you for your input. 🙏
I incorporated your feedback. Let me know if it's ok.

@github-actions github-actions bot temporarily deployed to Netlify January 12, 2024 17:41 Inactive
Copy link
Contributor

@RaquelHipolito RaquelHipolito left a comment

Choose a reason for hiding this comment

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

@claudiacarpinteiro @jorgebraz Left some comments. 🙏

@github-actions github-actions bot temporarily deployed to Netlify January 15, 2024 17:29 Inactive
@github-actions github-actions bot temporarily deployed to Netlify January 15, 2024 17:33 Inactive
@github-actions github-actions bot temporarily deployed to Netlify January 15, 2024 17:38 Inactive
@claudiacarpinteiro claudiacarpinteiro removed the don't merge Don't merge this pull request yet label Jan 15, 2024
@claudiacarpinteiro claudiacarpinteiro merged commit fa9fb98 into master Jan 15, 2024
7 of 8 checks passed
@claudiacarpinteiro claudiacarpinteiro deleted the PLUTO-802-gh-access-tokens-release-note branch January 15, 2024 17:53
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.

5 participants