feat: add non-English PR flagging workflow #12934

wackerow · 2024-05-08T19:32:23Z

Description

Adds a workflow that runs on all PRs
If PR has any files that touch non-English content (markdown or json) it will proceed
If above changes seen, the PR is labeled with "blocked" and "non-crowdin translation updates"
A comment is added, mentioning the author, directing to more information about the translation program, as well as a direct link to Crowdin requesting them to make these suggestion on that platform.
(Updates branch names used in Crowdin CI/CD imports to include crowdin; this allows us to easily ignore those branches)

Summary by CodeRabbit

New Features
- Implemented a GitHub Actions workflow to check for non-English content updates and guide contributors to use Crowdin for translations.
Improvements
- Updated branch naming convention for locale translation pull requests to include a "crowdin-" prefix for better identification.

netlify · 2024-05-08T19:32:39Z

✅ Deploy Preview for ethereumorg ready!

Name	Link
🔨 Latest commit	`7e1ab4b`
🔍 Latest deploy log	https://app.netlify.com/sites/ethereumorg/deploys/66460bdd83400a0008ec01ff
😎 Deploy Preview	https://deploy-preview-12934--ethereumorg.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	7 paths audited Performance: 48 (🔴 down 8 from production) Accessibility: 92 (no change from production) Best Practices: 89 (🔴 down 9 from production) SEO: 95 (no change from production) PWA: - View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Should only match markdown and JSON files, excluding all English JSONs.

wackerow · 2024-05-08T20:36:37Z

.github/workflows/non-english-warning.yml

+        with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
+          script: |
+            const prNumber = context.issue.number;


(GitHub treats PR's as a type of issue)

context made available from the Octokit package, which is automatically made available with actions/github-script@v5

wackerow · 2024-05-08T20:41:46Z

.github/workflows/non-english-warning.yml

+on:
+  pull_request:
+    paths:
+      - "public/content/translations/**/*.md"
+      - "src/intl/**/*.json"
+      - "!src/intl/en/**


Will check every PR for changes to these paths. If any file in the diff includes:

a markdown file within public/content/translations or

a JSON file within src/intl (but NOT in src/intl/en)

the job will run.

Only .md and .json; images and other files could be updated separately without Crowdin.

wackerow · 2024-05-08T20:44:12Z

.github/workflows/non-english-warning.yml

+      - name: Exit early if branch name contains 'crowdin'
+        run: |
+          if [[ "${{ github.head_ref }}" == *crowdin* ]]; then
+            echo "Branch name contains 'crowdin', stopping workflow"
+            exit 1
+          fi


Exits if crowdin is found in the branch name. The utils.ts update in this PR includes the addition of this string segment to the branch names generated in the Crowdin CI flow, so these will not be flagged.

Exiting with 1 (a non-zero status) will be seen as a "failure" and cause the following job to not run.

wackerow · 2024-05-08T20:46:58Z

.github/workflows/non-english-warning.yml

+          fi
+
+  add_label_and_comment:
+    needs: check_branch_name


Only if the branch is not a crowdin branch will this run

wackerow · 2024-05-13T10:59:16Z

Placing back in draft while I investigate a way to ignore href changes (ie, batch dead-link repairs do not need to be done through Crowdin first for the sake of patching).

wackerow · 2024-05-13T18:03:50Z

Challenging to find a clean approach to identifying that only href values were changed. Instead, patched with an update to identify if the changed lines at least include the string segment href, and to flag these with a "question" label instead of "blocked" label, altering the PR comment accordingly.

This still needs some testing; keeping in draft in the meantime

Test workflow?

minimalsm

Looks great, two nitpicks but your call. LGTM

minimalsm · 2024-05-15T15:20:13Z

.github/workflows/non-english-warning.yml

+            const commentWithoutHrefs = `This pull request contains changes to non-English content, which must be handled through the Crowdin platform instead of GitHub.`
+            const commentWithHrefs = `This pull request contains changes to non-English content files, which may need to be handled through the Crowdin platform instead of GitHub.


We don't want people to see this comment and close their PR, what do you think of adding this?

Suggested change

const commentWithoutHrefs = `This pull request contains changes to non-English content, which must be handled through the Crowdin platform instead of GitHub.`

const commentWithHrefs = `This pull request contains changes to non-English content files, which may need to be handled through the Crowdin platform instead of GitHub.

const commentWithoutHrefs = `This pull request contains changes to non-English content, which must also be handled through the Crowdin platform instead of GitHub.`

const commentWithHrefs = `This pull request contains changes to non-English content files, which may also need to be handled through the Crowdin platform instead of GitHub.

Sure! Just would also change "instead of GitHub." to "instead of only on GitHub." (or something similar)

.github/workflows/non-english-warning.yml

minimalsm · 2024-05-15T15:21:13Z

@coderabbitai review

coderabbitai · 2024-05-15T15:21:18Z

Actions Performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai · 2024-05-15T15:21:21Z

Walkthrough

The recent updates introduce a GitHub Actions workflow to monitor non-English content updates and enforce the use of Crowdin for translations. Additionally, a minor adjustment was made to the branch naming convention in the locale translation pull request function, adding a "crowdin-" prefix for clearer identification.

Changes

Files	Change Summary
`.github/workflows/non-english-warning.yml`	Introduced a workflow to check for non-English updates outside Crowdin, directing contributors to use Crowdin for translations.
`src/scripts/crowdin/translations/utils.ts`	Updated the branch name creation in the locale translation PR function to include a "crowdin-" prefix.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 2

.github/workflows/non-english-warning.yml

Co-authored-by: Joshua <62268199+minimalsm@users.noreply.github.com>

minimalsm

LGTM

wackerow added 2 commits May 8, 2024 12:27

feat: add workflow for flagging non-English PRs

542d3c7

feat: mention author

63d652d

wackerow requested review from corwintines, pettinarip, minimalsm and nhsz as code owners May 8, 2024 19:32

github-actions bot added needs review 👀 tooling 🔧 Changes related to tooling of the project labels May 8, 2024

fix: tighten rules to avoid matching images, etc

2b3e97e

Should only match markdown and JSON files, excluding all English JSONs.

wackerow commented May 8, 2024

View reviewed changes

wackerow changed the title ~~Non english prs~~ feat: add non-English PR flagging workflow May 8, 2024

chore: adjust body copy [skip ci]

1feb815

wackerow marked this pull request as draft May 13, 2024 10:59

wackerow added 2 commits May 13, 2024 12:15

Merge branch 'dev' into non-english-prs

2e2eecf

feat: add href logic

8189815

wackerow marked this pull request as ready for review May 15, 2024 13:17

minimalsm approved these changes May 15, 2024

View reviewed changes

coderabbitai bot reviewed May 15, 2024

View reviewed changes

.github/workflows/non-english-warning.yml Outdated Show resolved Hide resolved

.github/workflows/non-english-warning.yml Outdated Show resolved Hide resolved

wackerow and others added 2 commits May 15, 2024 16:54

chore: apply suggestions

85a1737

chore: rm comment

7e1ab4b

Co-authored-by: Joshua <62268199+minimalsm@users.noreply.github.com>

minimalsm approved these changes May 16, 2024

View reviewed changes

wackerow merged commit 18b97ac into dev May 20, 2024
6 checks passed

wackerow deleted the non-english-prs branch May 20, 2024 12:22

corwintines mentioned this pull request May 22, 2024

Release candidate: v8.6.0 #13016

Merged

corwintines mentioned this pull request May 22, 2024

Deploy v8.6.0 #13019

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add non-English PR flagging workflow #12934

feat: add non-English PR flagging workflow #12934

wackerow commented May 8, 2024 •

edited by coderabbitai bot

netlify bot commented May 8, 2024 •

edited

wackerow May 8, 2024

wackerow May 8, 2024

wackerow May 8, 2024 •

edited

wackerow May 8, 2024

wackerow May 8, 2024

wackerow May 8, 2024

wackerow May 8, 2024

wackerow commented May 13, 2024

wackerow commented May 13, 2024 •

edited

minimalsm left a comment

minimalsm May 15, 2024

wackerow May 15, 2024

minimalsm commented May 15, 2024

coderabbitai bot commented May 15, 2024

coderabbitai bot commented May 15, 2024 •

edited

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

minimalsm left a comment

		const commentWithoutHrefs = `This pull request contains changes to non-English content, which must be handled through the Crowdin platform instead of GitHub.`
		const commentWithHrefs = `This pull request contains changes to non-English content files, which may need to be handled through the Crowdin platform instead of GitHub.

feat: add non-English PR flagging workflow #12934

feat: add non-English PR flagging workflow #12934

Conversation

wackerow commented May 8, 2024 • edited by coderabbitai bot

Description

Summary by CodeRabbit

netlify bot commented May 8, 2024 • edited

✅ Deploy Preview for ethereumorg ready!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wackerow May 8, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wackerow commented May 13, 2024

wackerow commented May 13, 2024 • edited

minimalsm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

minimalsm commented May 15, 2024

coderabbitai bot commented May 15, 2024

coderabbitai bot commented May 15, 2024 • edited

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

minimalsm left a comment

Choose a reason for hiding this comment

wackerow commented May 8, 2024 •

edited by coderabbitai bot

netlify bot commented May 8, 2024 •

edited

wackerow May 8, 2024 •

edited

wackerow commented May 13, 2024 •

edited

coderabbitai bot commented May 15, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)