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: add cli for listing available patches #798

Merged
merged 1 commit into from
Mar 9, 2023

Conversation

MaferMazu
Copy link
Contributor

@MaferMazu MaferMazu commented Feb 8, 2023

Description

This PR adds tutor config patches list command with its functionality.

How to test

Run

tutor config patches list

Expected result:

PATCH                                          	LOCATIONS
caddyfile                                      	apps/caddy/Caddyfile
caddyfile-cms                                  	apps/caddy/Caddyfile
caddyfile-global                               	apps/caddy/Caddyfile
caddyfile-lms                                  	apps/caddy/Caddyfile
...
openedx-dockerfile-post-git-checkout           	build/openedx/Dockerfile
openedx-dockerfile-post-python-requirements    	build/openedx/Dockerfile
openedx-dockerfile-pre-assets                  	build/openedx/Dockerfile
openedx-lms-common-settings                    	apps/openedx/settings/lms/development.py
                                               	apps/openedx/settings/lms/production.py
openedx-lms-development-settings               	apps/openedx/settings/lms/development.py
openedx-lms-production-settings                	apps/openedx/settings/lms/production.py

If you had patches in a plugin patches (ex: You have defined caddyfile-mfe2 inside a caddyfile-global in a plugin):

PATCH                                          	LOCATIONS
caddyfile                                      	apps/caddy/Caddyfile
caddyfile-cms                                  	apps/caddy/Caddyfile
caddyfile-global                               	apps/caddy/Caddyfile
caddyfile-lms                                  	apps/caddy/Caddyfile
caddyfile-mfe2                                 	within patch: caddyfile-global
...

For more context about this PR: openedx-unsupported/wg-developer-experience#50

@regisb
Copy link
Contributor

regisb commented Feb 9, 2023

Looking good so far. Just let me know when you need a review.

@MaferMazu MaferMazu force-pushed the mfmz/listing-patches branch from c76b686 to d70f99a Compare February 21, 2023 16:01
@MaferMazu MaferMazu force-pushed the mfmz/listing-patches branch 3 times, most recently from c6e23fa to f762ff7 Compare March 1, 2023 23:14
@MaferMazu MaferMazu marked this pull request as ready for review March 1, 2023 23:17
@MaferMazu MaferMazu force-pushed the mfmz/listing-patches branch from f762ff7 to 1565d09 Compare March 1, 2023 23:36
@MaferMazu
Copy link
Contributor Author

This is ready for review @regisb @kdmccormick

Copy link
Contributor

@regisb regisb left a comment

Choose a reason for hiding this comment

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

I really like your implementation, which is very lean and does not change the rest of the codebase. Also, the command output looks great and quite useful. Finally, I appreciate the fact that you took the time to write extensive unit tests.

Can you just address the comments and add a changelog entry? https://docs.tutor.overhang.io/tutor.html#contributing-to-tutor

@kdmccormick
Copy link
Collaborator

Nice work. The output looks great! I have no suggestions beyond what @regisb has already said.

@MaferMazu MaferMazu force-pushed the mfmz/listing-patches branch from 1565d09 to e9c5c66 Compare March 8, 2023 14:14
@MaferMazu MaferMazu force-pushed the mfmz/listing-patches branch from e9c5c66 to 62958cc Compare March 8, 2023 14:20
@MaferMazu MaferMazu changed the title feat: add cli tool for listing available patches feat: add cli for listing available patches Mar 8, 2023
@MaferMazu MaferMazu requested a review from regisb March 8, 2023 14:20
@MaferMazu
Copy link
Contributor Author

MaferMazu commented Mar 8, 2023

This PR is ready @regisb

Copy link
Contributor

@regisb regisb left a comment

Choose a reason for hiding this comment

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

just great!

@regisb regisb merged commit f13627a into overhangio:master Mar 9, 2023
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.

3 participants