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!: remove effort field from CourseCatalogData #131

Merged
merged 1 commit into from
Oct 20, 2022

Conversation

rgraber
Copy link
Contributor

@rgraber rgraber commented Oct 18, 2022

Description:
Removes "effort" field in CourseCatalogData. This field is not actually editable in Studio in setups where Publisher is enabled. Also updates the ADR around COURSE_CATALOG_INFO_CHANGED event design to clarify the fields not being copied from the courses API endpoint.

Note that this is in fact a breaking change and will require some work in edx-platform (and possibly discovery) to bring it in.

Issue: #133

Reviewers:

  • tag reviewer
  • tag reviewer

Merge checklist:

  • All reviewers approved
  • CI build is green
  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Commits are squashed

Post merge:

  • Create a tag
  • Check new version is pushed to PyPI after tag-triggered build is
    finished.
  • Delete working branch (if not needed anymore)

@rgraber rgraber marked this pull request as draft October 18, 2022 17:49
@rgraber rgraber marked this pull request as ready for review October 19, 2022 16:58
Copy link
Contributor

@robrap robrap left a comment

Choose a reason for hiding this comment

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

Thanks.

CHANGELOG.rst Outdated Show resolved Hide resolved
docs/decisions/0009-course-catalog-info-changed-design.rst Outdated Show resolved Hide resolved
docs/decisions/0009-course-catalog-info-changed-design.rst Outdated Show resolved Hide resolved
@rgraber rgraber changed the title feat: remove effort field from CourseCatalogData feat!: remove effort field from CourseCatalogData Oct 20, 2022
@rgraber rgraber force-pushed the rsgraber/20221018-remove-effort-field branch from 367f968 to 55ef6f7 Compare October 20, 2022 12:14
@rgraber
Copy link
Contributor Author

rgraber commented Oct 20, 2022

Ended up rebasing/squashing to make sure my commit messages were all compliant, and because I forgot that would make your life slightly harder. I made all suggested changes to the ADR, changed the version to 3.0.0, and updated the Changelog. Those should be the only changes since your last review.

@rgraber rgraber requested a review from robrap October 20, 2022 12:18
@rgraber rgraber merged commit d2f4261 into main Oct 20, 2022
@rgraber rgraber deleted the rsgraber/20221018-remove-effort-field branch October 20, 2022 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants