Skip to content

docs: design workflow for xblock skill tagging - #140

Merged
sameenfatima78 merged 1 commit into
openedx:masterfrom
open-craft:navin/xblock-skill-tagging-doc
Feb 6, 2023
Merged

docs: design workflow for xblock skill tagging#140
sameenfatima78 merged 1 commit into
openedx:masterfrom
open-craft:navin/xblock-skill-tagging-doc

Conversation

@navinkarkera

@navinkarkera navinkarkera commented Feb 3, 2023

Copy link
Copy Markdown
Contributor

Adds document describing the whole workflow for xblock skill tagging.

Merge checklist:

  • Any new requirements are in the right place (do not manually modify the requirements/*.txt files)
    • make upgrade && make requirements have been run to regenerate requirements
  • ./manage.py makemigrations has been run
    • Checkout the Database Migration Confluence page for helpful tips on creating migrations.
    • Note: This must be run if you modified any models.
      • It may or may not make a migration depending on exactly what you modified, but it should still be run.
  • Version bumped
  • Changelog record added

Post merge:

  • Tag pushed and a new version released
    • Note: Assets will be added automatically. You just need to provide a tag (should match your version number) and title and description.
  • After versioned build finishes in GitHub Actions, verify version has been pushed to PyPI
    • Each step in the release build has a condition flag that checks if the rest of the steps are done and if so will deploy to PyPi.
      (so basically once your build finishes, after maybe a minute you should see the new version in PyPi automatically (on refresh))
  • PR created in course-discovery to upgrade dependencies (including taxonomy-connector)
    • This must be done after the version is visible in PyPi as make upgrade in course-discovery will look for the latest version in PyPi.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 3, 2023
@openedx-webhooks

openedx-webhooks commented Feb 3, 2023

Copy link
Copy Markdown

Thanks for the pull request, @navinkarkera! 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.

@navinkarkera
navinkarkera force-pushed the navin/xblock-skill-tagging-doc branch from 21aefad to 8fcdc51 Compare February 3, 2023 10:40
@navinkarkera
navinkarkera marked this pull request as ready for review February 3, 2023 11:19
@navinkarkera

Copy link
Copy Markdown
Contributor Author

@sameenfatima78 Please let me know your thoughts on the document as well as whether this is a good place to keep it.

@navinkarkera
navinkarkera force-pushed the navin/xblock-skill-tagging-doc branch from 8fcdc51 to 8b7e77c Compare February 3, 2023 11:24

@robrap robrap left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

  1. This is immensely helpful. Thank you!
  2. Were there any Rejected Alternatives to document?
  3. I’ll leave the more detailed review to the teams involved.

Comment thread docs/decisions/0001-xblock-skill-tagging-design.rst Outdated
@mphilbrick211

Copy link
Copy Markdown

Hi @moconnell1453! Flagging this for your review.

@navinkarkera
navinkarkera force-pushed the navin/xblock-skill-tagging-doc branch from 8b7e77c to 8149528 Compare February 6, 2023 07:58
@navinkarkera

Copy link
Copy Markdown
Contributor Author

@robrap Thank you!

Were there any Rejected Alternatives to document?

No.

@navinkarkera

Copy link
Copy Markdown
Contributor Author

@moconnell1453 Thank you! I cannot merge it as I don't have merge rights.

@sameenfatima78 sameenfatima78 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks awesome @navinkarkera, thanks for this!

@sameenfatima78

Copy link
Copy Markdown
Member

@moconnell1453 Thank you! I cannot merge it as I don't have merge rights.

@navinkarkera I'll take care of it.

@sameenfatima78
sameenfatima78 merged commit 61d8878 into openedx:master Feb 6, 2023
@openedx-webhooks

Copy link
Copy Markdown

@navinkarkera 🎉 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.

6 participants