Package: repobee-feedback
repobee-feedbackrepobee-feedback v0.6.0 requires RepoBee 3:As ofrepobee-feedbackv0.6.0, RepoBee 3+ is required.ARepoBeeplugin that adds thefeedbackto to RepoBee'sissuescategory. It allows the user to specify a
directory containingissue files. Issue files are simply markdown files in
which the first line is taken to be the title of the issue, and the rest the
body. Thefeedbackcommand looks for issue files called<STUDENT_REPO_NAME>.md, and opens them in the respective student repos.Alternatively, you can also use a special file format to put all issues into
the same file, seeThe multi issues file.How isfeedbackdifferent fromissues open?Theissues opencommand opens the same issue in all student repositories, while thefeedbackaction allows for unique issues to be opened in each repository.InstallUse RepoBee's plugin manager to install.$repobeeplugininstallUsageWhen active, thefeedbackplugin adds thefeedbackaction to theissuescategory.
We recommend activating thefeedbackplugin persistently withrepobee plugin activate, such that the action is always available. See theRepoBee plugin
docsfor general information on how to use installed plugins, including activation
and deactivation. The rest of this section assumes that thefeedbackplugin has
been activated persistently.The issue filesfeedbacklooks for files called<STUDENT_REPO_NAME>.md. So, if you for
example want to open feedback issues for studentsslarseandrjglassefor
assignmenttask-1, it will expect the filesslarse-task-1.mdandrjglasse-task-1.mdto be present in the issue files directory. More files can
be present, but if any of the expected issue files are missing, an error is
displayed and no issues are opened.The issue files should be Markdown-formatted.The first line of the file is
the title, the rest is the body.Note that the title (i.e. first line) should
not contain any formatting as it typically does not render well on
GitHub/GitLab.The multi issues fileAlternatively, you can put all issues into a single file and specify the path
to it with the--multi-issues-fileargument (seeOptional
arguments). Each issue should begin with#ISSUE#<STUDENT_REPO_NAME>#<ISSUE_TITLE>, and everything between that line
and the next such line is considered to be the body of the issue. Here is an
example file with issues for studentsslarseandrjglassefor assignmenttask-1.#ISSUE#slarse-task-1#This is a neat title
Well done mr slarse, you did good here.
You could have done a bit better on blabla, though.

Overall well done!

#ISSUE#rjglasse-task-1#This is another title
Hmm, not sure what's going on here.

Could you explain it better?Note:The first line of the multi issues file must be an#ISSUE#line.Using thefeedbackcommandThefeedbackcommand is straightforward. It takes the "regular" options
that most RepoBee commands (base url, token, etc), but these are also picked
from the config file as per usual. With a typical RepoBee configuration, you
only need to supply-a|--assignmentsand-s|--students(or--sf|--students_file). Here's an example:$ repobee issues feedback -a task-1 -s slarse rjglasseThis will causefeedbackto search through the current directory (which
is the default issue directory) forslarse-task-1.mdandrjglasse-task-1.md.Note:By default,feedbackruns in interactive mode: it will
prompt youy/nbefore opening an issue. See the next section for how to
disable that.Refer to thefeedbackaction's help section for details on additional CLI options.$ repobee issues feedback --helpLicenseSeeLICENSEfor details.