Skip to content

Commit

Permalink
chore: cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
zojize committed Jul 3, 2024
1 parent 2e50a7f commit 3a18dab
Show file tree
Hide file tree
Showing 6 changed files with 67 additions and 3,228 deletions.
4 changes: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,20 +33,16 @@ autograding:
log_date: true
assignment: mp1-autograding
upstream_repo: dsdiscovery/microprojects
autograding_status: ${{ steps.autograding.outcome }}
points: ${{ steps.autograding.outputs.Points }}
```
Assuming `http://arbitrary.remote.server:5000/` is a route that allows POST requests, the server may receive the following JSON:

```json
{
"assignment": "mp1-autograding",
"autograding_status": "success",
"date": "2024-01-01T00:00:00.000Z",
"github_sha": "ffac537e6cbbf934b08745a378932722df287a53",
"meta": {},
"points": "21/42",
"repo": "microprojects",
"token": "ghs_5oMEt0k3n",
"upstream_ref": "mp1-autograding",
Expand Down
28 changes: 2 additions & 26 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,8 @@ inputs:
description: >
The URL to an HTTP endpoint to which this action will send telemetry data. Specifically,
if `endpoint` is a valid endpoint, `telemetry` will send a POST request the endpoint
containing JSON-formatted telemetry data in the request body. If this field is left blank,
`create_artifact` must be set to `true`. Otherwise, this action will fail immediately.
required: false
create_artifact:
description: >
Boolean describing if this workflow should produce an artifact containing telemetry data.
The data will be saved as JSON, and will contain all the same data as what is sent to `endpoint`.
The artifact will be named `telemetry`.
default: 'false'
required: false
containing JSON-formatted telemetry data in the request body.
required: true
token:
description: >
GitHub token used to check repository content and provide feedback. By default,
Expand All @@ -33,22 +25,6 @@ inputs:
The branch, tag or SHA of the upstream repo. Uses the default branch if unspecified,
or the assignment name if it is specified.
required: false
log_date:
description: >
Boolean describing if `telemetry` should log the date and time of the workflow run.
default: 'true'
required: false
autograding_status:
description: >
`autograding`'s exit code. If this field is left blank, this information is not logged.
required: false
points:
description: >
String containing the ratio of points earned to total points from the `autograding` action.
If the `autograding` action has not been used in the same workflow as this action or if this
action is used earlier than `autograding` in a workflow, this field should always be left
to its default value.
required: false
assignment:
description: >
The name of the assignment for which data is being logged. If empty, this field will not be entered.
Expand Down
Loading

0 comments on commit 3a18dab

Please sign in to comment.