A GitHub App hosted as an Azure Function processing GitHub webhooks. The purpose is to monitor GitHub repositories of student homework assignments for conformance with the expected workflow.

The basis of operation is

1. a GitHub organization where the student assignments are stored, managed by GitHub Classroom;
2. a running instance of this application hosted as an Azure Function with a public URL;
3. and a GitHub App pointing to the Azure function, added to the GitHub organization (handling events in all repository of the GitHub organization).

The GitHub App built from this source is private, but feel free to fork the source code and create your own.

The application requires the following configurations specified as environment variables.

AHK_GitHubAppId and AHK_GitHubAppPrivateKey: (mandatory) the ID and the private key of the GitHub App (both available in GitHub App management page).

All GitHub interactions from the application will be performed in the name of this GitHub App.

AHK_GitHubWebhookSecret: (mandatory) the secret that is configured in the GitHub App. The secret is mandatory; unsecured webhook calls are rejected by the application.

The application reads a yaml configuration file stored in the GitHub repository triggering the events. The configuration file is used to enable the functionalities of this application as follows.

The configuration file must be stored on the default branch in file .github/ahk-monitor.yml.

The configuration file:

enabled: true

If this file is not present, enabled is not set to true, or the file cannot be parsed, the fired event is ignored. Further settings are available as specified by each enforced rule below.

The application enforces the following rules.

1. The default branch is not touched by the student. The solution is submitted on a new branch via a pull request.
2. There are no force pushes.

These rules are enforced by marking all branches as protected, and requiring review of pull requests targeting the default branch.

This rule is enabled by default. The rule can be configured in the repository settings file:

...
branchProtection:
  enabled: true

1. No user edits or deletes an issue comment made by someone else.

This rule is ensured by registering such an attempt and adding a comment into the issue thread where the edit/delete took place.

This rule is enabled by default. The rule can be configured in the repository settings file:

...
commentProtection:
  enabled: true
  warningText: "This text is added as a comment into the PR."

1. There is no more than one open pull request at any time.
2. A pull request should not be opened once a PR has been closed by the teacher.

Explanation: An open pull requests is a submission of the work. There can only be one submission. A submission can be revoked by closing the pull requests. If a submission has already been evaluated (the PR has been closed by the teacher), no more submission (new PRs) are allowed.

These rules are ensured by registering such an event and adding a comment into the affected PR issue threads.

This rule is enabled by default. The rule can be configured in the repository settings file:

...
multiplePRProtection:
  enabled: true
  warningText: "This text is added as a comment into the PR and references to related PRs are added {} here."

1. Pull requests should be assigned to the instructor for evaluation. When a review is requested instead, assign the instructor.

Explanation: To track submitted work the pull requests should be assigned to the instructor. This allows the instructor to use GitHub web interface to go through all submissions. Requesting a review of a pull request is frequently mixed up with assignment. Although GitHub has a list of requested reviews, if the instructor choses to request a change in the submission, the pull request is removed from this list. If the student makes changes to the pull request as the result of the change request, the pull request does not show up in the pending reviews list. To ensure tracking these pull requests too, any reviewer is automatically set as assignee too.

This rule is enabled by default. The rule can be configured in the repository settings file:

...
reviewerToAssignee:
  enabled: true

1. Install the Run Coverlet Report extension to Visual Studio
2. Install the ReportGenerator global tool

    dotnet tool install -g dotnet-reportgenerator-globaltool

3. Use Tools/Run Code Coverage to generate a report