From 594337a54d2bc695bb5a5d23053aef757910340f Mon Sep 17 00:00:00 2001 From: arthurcai Date: Fri, 19 Sep 2025 19:43:58 +0800 Subject: [PATCH] doc: update README and add new commands --- README.md | 39 ++++++++++++++++++++++++++++++++++++--- 1 file changed, 36 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9b0f9da..6a4b250 100644 --- a/README.md +++ b/README.md @@ -60,11 +60,24 @@ clone all gitea repos to local close all issues and pull requests in gitea organization -### `create-channels-on-mm` +### `create-group-channels-on-mm` -create channels for student groups according to group information on gitea. Optionally specify a prefix to ignore all repos whose names do not start with it. Optionally specify a suffix to add to all channels created. +create Mattermost channels for student groups based on team information on Gitea -Example: `python3 -m joint_teapot create-channels-on-mm --prefix p1 --suffix -private --invite-teaching-team` will fetch all repos whose names start with `"p1"` and create channels on mm for these repos like "p1team1-private". Members of a repo will be added to the corresponding channel. And teaching team (adjust in `.env`) will be invited to the channels. +**Options**: +- `--prefix TEXT`: Only process repositories starting with this prefix +- `--suffix TEXT`: Add suffix to created channels +- `--invite-teaching-team/--no-invite-teaching-team`: Whether to invite teaching team (default: invite) + +Example: `joint-teapot create-group-channels-on-mm --prefix "hteam" --suffix "-gitea"` will Create channels for webhook integration. Members of "hteam*" repo will be added to the corresponding channel. And teaching team (adjust in `.env`) will be invited to the channels. + +### `create-personal-channels-on-mm` + +create personal Mattermost channels for every student + +**Options**: + +- `--invite-teaching-team/--no-invite-teaching-team`: Whether to invite teaching team (default: invite) ### `create-comment` @@ -125,6 +138,26 @@ Example: `python3 -m joint_teapot unsubscribe-from-repos '\d{12}$'` will remove upload assignment grades to canvas from grade file (GRADE.txt by default), read the first line as grade, the rest as comments +### `label-issues` + +add a label to specific issues in a repository, create labels if not exist, with dry-run disabled by default. You may adjust the color of the label with `--color "#******"` if the label doesn't exist. + +### `delete-labels` + +remove a label from specific issues or delete the repository labels, with dry-run disabled by default. + +### `close-issues` + +close one or more specific issues in a repository, with dry-run disabled by default. + +### `update-group-channels-on-mm` + +update Mattermost channels for student groups based on team information on Gitea. It will only add missing users, never delete anyone. + +### `update-personal-channels-on-mm` + +update personal Mattermost channels for every student. It will only add missing users, never delete anyone. + ## License MIT