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: post translation validation errors as a GitHub comment | FC-0012 #1894

Merged
merged 1 commit into from
Oct 19, 2023

Conversation

OmarIthawi
Copy link
Member

@OmarIthawi OmarIthawi commented Oct 18, 2023

Problem

Locating the validation error can be difficult in the GitHub Actions check.

Solution

Post a comment (e.g. #1894 (comment)) in the pull request with failed translations.

The comments are "sticky" to avoid spamming the pull requests with multiple comments.

Limitation: forks no supported

This won't affect us because bots writes directly to this repository.

Testing results

Testing results with screenshots
  • Successful validation: image
  • Failed result: image

References

This contribution is part of the FC-0012 project which is sparked by the Translation Infrastructure update OEP-58.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 18, 2023
@openedx-webhooks
Copy link

openedx-webhooks commented Oct 18, 2023

Thanks for the pull request, @OmarIthawi! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@github-actions
Copy link

github-actions bot commented Oct 18, 2023

✅ All translation files are valid.

This comment has been posted by the validate-translation-files.yml GitHub Actions workflow.

@OmarIthawi OmarIthawi force-pushed the python_validate_translations branch 3 times, most recently from 88cfc94 to 90bc72e Compare October 18, 2023 16:39
@openedx openedx deleted a comment from github-actions bot Oct 18, 2023
@openedx openedx deleted a comment from github-actions bot Oct 18, 2023
@openedx openedx deleted a comment from github-actions bot Oct 18, 2023
@OmarIthawi OmarIthawi force-pushed the python_validate_translations branch from 90bc72e to 56fc636 Compare October 18, 2023 16:41
@openedx openedx deleted a comment from github-actions bot Oct 18, 2023
@openedx openedx deleted a comment from github-actions bot Oct 18, 2023
@openedx openedx deleted a comment from github-actions bot Oct 18, 2023
@openedx openedx deleted a comment from github-actions bot Oct 18, 2023
@OmarIthawi OmarIthawi marked this pull request as ready for review October 18, 2023 16:42
Copy link
Contributor

@shadinaif shadinaif left a comment

Choose a reason for hiding this comment

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

neat! I like it. Thank you @OmarIthawi

@OmarIthawi OmarIthawi merged commit f6fd2d8 into main Oct 19, 2023
4 checks passed
@OmarIthawi OmarIthawi deleted the python_validate_translations branch October 19, 2023 12:21
@openedx-webhooks
Copy link

@OmarIthawi 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@itsjeyd itsjeyd added the core contributor PR author is a Core Contributor (who may or may not have write access to this repo). label Oct 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants