ethereum-org-website icon indicating copy to clipboard operation
ethereum-org-website copied to clipboard

feat: add non-English PR flagging workflow

Open wackerow opened this issue 9 months ago • 6 comments

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.

wackerow avatar May 08 '24 19:05 wackerow

Deploy Preview for ethereumorg ready!

Name Link
Latest commit 7e1ab4bb4037a4f3bdd4896a68dc6e02f9968a8c
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...

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.

netlify[bot] avatar May 08 '24 19:05 netlify[bot]

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 avatar May 13 '24 10:05 wackerow

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?

wackerow avatar May 13 '24 18:05 wackerow

@coderabbitai review

minimalsm avatar May 15 '24 15:05 minimalsm

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[bot] avatar May 15 '24 15:05 coderabbitai[bot]

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[bot] avatar May 15 '24 15:05 coderabbitai[bot]