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

chore: release docs and script updates | FC-12 #6056

Merged
merged 1 commit into from
May 14, 2024

Conversation

OmarIthawi
Copy link
Member

This refreshes the repository docs and scripts with the Redwood release.

Done

  • Remove the sync_translations script and its workflow. Its job has been done
  • Update current status in README and added links for branches
  • Document maintainer tools
  • Support TRANSIFEX_PROJECT_SLUG in make fix_transifex_resource_names_dry_run

Not done

@openedx-webhooks
Copy link

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 10, 2024
if not slug:
raise RuntimeError(
'Error: Cannot determine Transifex project slug. Set `TRANSIFEX_PROJECT_SLUG` environment variable to '
'"openedx-translations" or "openedx-translations-redwood".'
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we want to mention redwood specifically here, or should this error be more generic (something like openedx-translations-{release-name}?

Copy link
Contributor

Choose a reason for hiding this comment

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

That's a good point. I think we should use release-name everywhere in these docs, because otherwise we'll definitely forget to update this for every release.

You could provide a link to https://openedx.atlassian.net/wiki/spaces/OEPM/pages/4191191044/Open+edX+Releases+Homepage for the name of the current and next releases.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good note, done!

Copy link
Contributor

@brian-smith-tcril brian-smith-tcril left a comment

Choose a reason for hiding this comment

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

Thank you so much for this!

Copy link
Contributor

@sarina sarina left a comment

Choose a reason for hiding this comment

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

Couple of requested changes but looks great, thank you

README.rst Outdated Show resolved Hide resolved
README.rst Outdated
Tools for repository maintainers
********************************

This repository contains both GitHub Actions workflows and Makefile programs
Copy link
Contributor

Choose a reason for hiding this comment

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

Are the GHA workflows defined in https://github.com/openedx/.github ?

Copy link
Contributor

Choose a reason for hiding this comment

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

The workflows are specific to this repo. For example: extract-translation-source-files.yml pulls from a bunch of repos throughout the org and makes commits to this repo adding source strings. No github actions are needed on other repos for this process to work.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good note. I've added a link to avoid confusion.

This repository makes an unusual use of GitHub Actions, therefore it's a special noteworthy case.

if not slug:
raise RuntimeError(
'Error: Cannot determine Transifex project slug. Set `TRANSIFEX_PROJECT_SLUG` environment variable to '
'"openedx-translations" or "openedx-translations-redwood".'
Copy link
Contributor

Choose a reason for hiding this comment

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

That's a good point. I think we should use release-name everywhere in these docs, because otherwise we'll definitely forget to update this for every release.

You could provide a link to https://openedx.atlassian.net/wiki/spaces/OEPM/pages/4191191044/Open+edX+Releases+Homepage for the name of the current and next releases.

@OmarIthawi OmarIthawi force-pushed the release_docs_and_scripts branch 3 times, most recently from bae56cb to 42fa896 Compare May 10, 2024 16:00
@OmarIthawi OmarIthawi requested a review from sarina May 10, 2024 16:04
@OmarIthawi
Copy link
Member Author

@sarina I've addressed the notes, please let me know if anything else is needed.

Copy link
Contributor

@sarina sarina left a comment

Choose a reason for hiding this comment

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

Hey @OmarIthawi sorry I made a comment too fast, and didn't indicate I wanted that change throughout the document.

README.rst Outdated Show resolved Hide resolved
README.rst Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
@OmarIthawi OmarIthawi force-pushed the release_docs_and_scripts branch 2 times, most recently from 0d88859 to ceef6b6 Compare May 11, 2024 16:55
README.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@sarina sarina left a comment

Choose a reason for hiding this comment

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

Looks great! Suggest removing a couple lines that I think are holdovers otherwise good to merge

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
@OmarIthawi
Copy link
Member Author

Great! Thanks @brian-smith-tcril and @sarina!!

@OmarIthawi OmarIthawi merged commit ba893de into openedx:main May 14, 2024
5 checks passed
@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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