Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@zojize
zojize committed Jun 25, 2024
1 parent 9e30047 commit 36435a9
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ autograding:
endpoint: 'http://arbitrary.remote.server/'
create_artifact: true
log_date: true
user: ${{ github.actor }}
assignment: mp1-autograding
upstream_repo: dsdiscovery/microprojects
autograding_status: ${{ steps.autograding.outcome }}
points: ${{ steps.autograding.outputs.Points }}
assignment: mp1-autograding
```
Assuming `http://arbitrary.remote.server:5000/` is a route that allows POST requests, the server will receive the following JSON:
Expand All @@ -51,17 +51,18 @@ Assuming `http://arbitrary.remote.server:5000/` is a route that allows POST requ

## Parameters

| Parameter | Required? | Description | Default |
| -------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| `endpoint` | No | 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. | `''` |
| `create_artifact` | No | 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`. | `false` |
| `token` | No | GitHub token used to check repository content and provide feedback. By default, this uses the repository token provided by GitHub Actions. You can customize this by replacing this token with a user token which has write-access to your repository. Note that the token will be accessible to all repository collaborators. | `false` |
| `upstream_repo` | No | Upstream project repository name with owner. For example, dsdiscovery/microprojects. Fails the action if endpoint is specified but upstream_repo is not. | `false` |
| `upstream_ref` | No | The branch, tag or SHA of the upstream repo. Uses the default branch if unspecified, or the assignment name if it is specified. | `false` |
| `log_date` | No | Boolean describing if `telemetry` should log the date and time of the workflow run. | `true` |
| `autograding_status` | No | `illinois/autograding`'s exit code. If this field is left blank, this information is not logged. | `''` |
| `points` | No | 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. | `''` |
| `assignment` | No | The name of the assignment for which data is being logged. If empty, this field will not be entered. | `''` |
| Parameter | Required? | Description | Default |
| -------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
| `endpoint` | No | 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. | `''` |
| `create_artifact` | No | 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`. | `false` |
| `token` | No | GitHub token used to check repository content and provide feedback. By default, this uses the repository token provided by GitHub Actions. You can customize this by replacing this token with a user token which has write-access to your repository. Note that the token will be accessible to all repository collaborators. | `${{ github.token }}` |
| `upstream_repo` | No | Upstream project repository name with owner. For example, dsdiscovery/microprojects. Fails the action if endpoint is specified but upstream_repo is not. | `false` |
| `upstream_ref` | No | The branch, tag or SHA of the upstream repo. Uses the default branch if unspecified, or the assignment name if it is specified. | `false` |
| `log_date` | No | Boolean describing if `telemetry` should log the date and time of the workflow run. | `true` |
| `autograding_status` | No | `illinois/autograding`'s exit code. If this field is left blank, this information is not logged. | `''` |
| `points` | No | 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. | `''` |
| `assignment` | No | The name of the assignment for which data is being logged. If empty, this field will not be entered. | `''` |
| `meta` | No | Arbitrary metadata that gets passes directly to the telemetry endpoint, defaults to "{}". | `'{}'` |

## Acknowledgements

Expand Down

0 comments on commit 36435a9

Please sign in to comment.