Implement Role Marker and Wrapper Function for Github Cli by desmondwong1215 · Pull Request #266 · git-mastery/exercises

desmondwong1215 · 2026-02-24T10:38:04Z

Add Role Marker.
Add helper function to add config to gitmastery-exercise.json.
Add wrapper function for GitHub CLI.

github-actions · 2026-02-24T10:38:20Z

Hi @desmondwong1215, thank you for your contribution! 🎉

This PR comes from your fork desmondwong1215/exercises on branch infra/tour9-10-autograding.

Before you request for a review, please ensure that you have tested your changes locally!

Important

The previously recommended way of using ./test-download.py is no longer the best way to test your changes locally.

Please read the following instructions for the latest instructions.

Prerequisites

Ensure that you have the gitmastery app installed locally (instructions)

Testing steps

If you already have a local Git-Mastery root to test, you can skip the following step.

Create a Git-Mastery root locally:

gitmastery setup

Navigate into the Git-Mastery root (defaults to gitmastery-exercises/):

cd gitmastery-exercises/

Edit the .gitmastery.json configuration file. You need to set the following values under the exercises_source key.

{
    # other fields...
    "exercises_source": {
        "username": "desmondwong1215",
        "repository": "exercises",
        "branch": "infra/tour9-10-autograding"
    }
}

Then, you can use the gitmastery app to download and verify your changes locally.

gitmastery download <your new change>
gitmastery verify

Checklist

(For exercises and hands-ons) I have verified that the downloading behavior works
(For exercises only) I have verified that the verification behavior is accurate

Important

To any reviewers of this pull request, please use the same instructions above to test the changes.

exercise_utils/exercise_config.py

VikramGoyal23 · 2026-03-18T05:28:08Z

exercise_utils/exercise_config.py

+def add_pr_config(pr_number: int, pr_repo_full_name: str) -> None:
+    update_config_fields(


A short docstring here would be nice, something like:

Suggested change

def add_pr_config(pr_number: int, pr_repo_full_name: str) -> None:

update_config_fields(

def add_pr_config(pr_number: int, pr_repo_full_name: str) -> None:

"""Adds a PR config to .gitmastery-exercise.json."""

update_config_fields(

VikramGoyal23 · 2026-03-18T05:53:25Z

exercise_utils/github_cli.py

+    command = _build_pr_command(
+        "list",
+        "--state",
+        validated_state,
+        "--json",
+        "number,title,state,author,headRefName,baseRefName",
+        repo_name=repo_name,
+    )


Keep in mind that doing it this way only lists the 30 most recent PRs. To list more/less of them, I recommend adding the --limit flag with a limit parameter which allows you to manually define the number of PRs to list.

exercise_utils/github_cli.py

VikramGoyal23 · 2026-03-18T06:10:36Z

exercise_utils/github_cli.py

+def list_prs(state: str, repo_name: str, verbose: bool) -> list[dict[str, Any]]:
+    """
+    List pull requests.
+    PR state filter ('open', 'closed', 'merged', 'all')
+    """
+    validated_state = _validate_choice(state, _PR_STATES, "state")
+    command = _build_pr_command(
+        "list",
+        "--state",
+        validated_state,
+        "--json",
+        "number,title,state,author,headRefName,baseRefName",
+        repo_name=repo_name,
+    )
+
+    result = run(command, verbose)
+
+    if result.is_success():
+        parsed = _parse_json_or_default(result.stdout, [])
+        return parsed if isinstance(parsed, list) else []
+    return []


I highly recommend adding support for the --search flag since I foresee it being useful in the future.

VikramGoyal23 · 2026-03-19T01:18:09Z

exercise_utils/roles.py

+        repo_name: str,
+        verbose: bool,
+    ) -> bool:
+        """Submit a review on a pull request with automatic role marker.     True if review was submitted successfully, False otherwise"""


Incorrect docstring formatting. Considering changing it to:

Suggested change

"""Submit a review on a pull request with automatic role marker. True if review was submitted successfully, False otherwise"""

"""

Submit a review on a pull request with automatic role marker.

True if review was submitted successfully, False otherwise

"""

VikramGoyal23 · 2026-03-19T01:19:08Z

exercise_utils/roles.py

+        """Format text with a role marker.
+        Example:


Formatting nit:

Suggested change

"""Format text with a role marker.

Example:

"""

Format text with a role marker.

Example:

VikramGoyal23 · 2026-03-19T01:19:28Z

exercise_utils/roles.py

+    """Wrapper for git and GitHub operations with automatic role marker formatting.
+


Formatting nit:

Suggested change

"""Wrapper for git and GitHub operations with automatic role marker formatting.

"""

Wrapper for git and GitHub operations with automatic role marker formatting.

VikramGoyal23

Mostly LGTM, just some nits regarding role helpers.

VikramGoyal23 · 2026-03-19T05:05:58Z

exercise_utils/roles.py

+        verbose: bool,
+    ) -> Optional[int]:
+        """Create a pull request with automatic role markers."""
+        return github_cli.create_pr(
+            self._format_text(title),
+            self._format_text(body),
+            base,
+            head,
+            repo_name,
+            verbose,
+        )


Developers are unable to create draft PRs with role markers since this function doesn't allow passing in a draft parameter.

Suggested change

verbose: bool,

) -> Optional[int]:

"""Create a pull request with automatic role markers."""

return github_cli.create_pr(

self._format_text(title),

self._format_text(body),

base,

head,

repo_name,

verbose,

)

verbose: bool,

draft: bool = False,

) -> Optional[int]:

"""Create a pull request with automatic role markers."""

return github_cli.create_pr(

self._format_text(title),

self._format_text(body),

base,

head,

repo_name,

verbose,

draft,

)

VikramGoyal23 · 2026-03-19T05:11:29Z

exercise_utils/roles.py

+        comment: Optional[str] = None,
+        verbose: bool = False,
+    ) -> bool:
+        """Close a pull request without merging."""
+        formatted_comment = self._format_text(comment) if comment else None
+        return github_cli.close_pr(pr_number, repo_name, formatted_comment, verbose)


This is missing the delete_branch parameter. Running this command will add the delete-branch flag according to the value of verbose.

Suggested change

comment: Optional[str] = None,

verbose: bool = False,

) -> bool:

"""Close a pull request without merging."""

formatted_comment = self._format_text(comment) if comment else None

return github_cli.close_pr(pr_number, repo_name, formatted_comment, verbose)

comment: Optional[str] = None,

delete_branch: bool = False,

verbose: bool = False,

) -> bool:

"""Close a pull request without merging."""

formatted_comment = self._format_text(comment) if comment else None

return github_cli.close_pr(

pr_number,

repo_name,

formatted_comment,

delete_branch,

verbose

)

VikramGoyal23

LGTM!

VikramGoyal23 · 2026-03-25T04:33:01Z

exercise_utils/exercise_config.py

+        if not value:
+            continue


Are you sure about this change? What this effectively does is prevent you from putting Falsy values as updates to values (e.g. False, "", []). While you most likely do not want to update a config with Falsy values, all this really does is add a bit of inflexibility to the use of the function.

desmondwong1215 changed the title ~~Implement infrastructure for Tour 9 and 10 autograding~~ Implement infrastructure for autograding Tour 9 and 10 Feb 24, 2026

desmondwong1215 changed the title ~~Implement infrastructure for autograding Tour 9 and 10~~ Implement Role Marker and Wrapper Function for Github Cli Feb 25, 2026

VikramGoyal23 self-requested a review February 27, 2026 09:46

desmondwong1215 added 4 commits March 9, 2026 13:45

Implement Role Marker

dd3a1f0

Add wrapper for gh cli

8b646cb

Reformat file

02ce7ad

Update config and github_cli

f958bf8

desmondwong1215 marked this pull request as draft March 10, 2026 03:00

Update config and github_cli

b6eee08

desmondwong1215 force-pushed the infra/tour9-10-autograding branch from cebe009 to b6eee08 Compare March 10, 2026 05:01

desmondwong1215 marked this pull request as ready for review March 10, 2026 05:03

desmondwong1215 added 5 commits March 10, 2026 14:05

Update exercise_config

2c07ccc

Rename repo_full_name to pr_repo_full_name

c18d8f3

Update exercise_config

475df72

Update github_cli

6edb4f5

Update github_cli wrapper function

28661aa

VikramGoyal23 requested changes Mar 19, 2026

View reviewed changes

desmondwong1215 added 4 commits March 19, 2026 10:59

Update github_cli

ff28694

Update exercise_config

98796ef

Fix formatting issues

2945eed

Update list_prs github_cli

5b33f09

desmondwong1215 requested a review from VikramGoyal23 March 19, 2026 04:34

VikramGoyal23 requested changes Mar 19, 2026

View reviewed changes

Add missing parameters

7b91c5a

VikramGoyal23 approved these changes Mar 19, 2026

View reviewed changes

Fix bug when merging config

19d98a2

VikramGoyal23 reviewed Mar 25, 2026

View reviewed changes

Update exercise_config

701f5b2

		def add_pr_config(pr_number: int, pr_repo_full_name: str) -> None:
		update_config_fields(

		"""Wrapper for git and GitHub operations with automatic role marker formatting.

Conversation

desmondwong1215 commented Feb 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Feb 24, 2026

Prerequisites

Testing steps

Checklist

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

VikramGoyal23 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

VikramGoyal23 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

desmondwong1215 commented Feb 24, 2026 •

edited

Loading