Course automation: Automatic validation and labeling

[altaired]

Course automation: Automatic validation and labeling

Members

Simon Persson (siper@kth.se)

GitHub: @altaired

Proposal

I plan to make a github action that automatially asigns labels depending on the category of the proposal and a "proposal" label (if it is a new proposal). The action should also validate the folder naming structure and that a README file is included properly. This would allow the TA's to easily filter out what PR:s to check.

In order to achive this, the following will have to be done:

• Validate the folder structure and README on each push
• Check on each PR what file / files has been modified, to determine what category the PR is related to. Also check if files that should't have been modified are included and if that's the case, return an error to the user.
• Assign the appropriate labels
• Report back the status if the PR is following the required structure.
• Create a report showing statistics over the number of proposals.

[SophieHYe]

Hi Simon,

Thanks for the interesting proposal.
"Check on each PR what file / files has been modified", maybe also think about the actions for some corner cases: multiple files/folders are modified, etc.
We would love to have a report from your work to trace the number/status/kth_ids/other details of all PRs.

Please update your PR accordingly, then we will merge it soon. Thanks!

[altaired]

If I understand the process of a proposal correctly it is supposed to initially ONLY contain a README.md file, or are other files for a proposal allowed? The action would make sure only one user-user/category folder is modified per PR (if multiple it is not approved?). In terms of statistics, would it be interesting to see how many of each category is submitted, the total number of proposals a.s.o, or which statistics are interesting for you to have? I'm thinking as there was a PR merged already for summarizing statistics in a file.

I've changed the proposal a little bit, is that what you mean @SophieHYe ?

[SophieHYe]

Hi,

• If I understand the process of a proposal correctly it is supposed to initially ONLY contain a README.md file, or are other files for a proposal allowed?

In theory, Yes. You understood correctly. But we always do have some students modify multiple files to register multiple tasks. You can considered it as exceptions.

• In terms of statistics, would it be interesting to see how many of each category is submitted, the total number of proposals a.s.o, or which statistics are interesting for you to have? I'm thinking as there was a PR merged already for summarizing statistics in a file.

Yes, indeed other students would like to contribute in the statistics. It would be nice if you can operator.

Thanks for the update. I am now merging your PR.