Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
giovanni-orciuolo authored Feb 1, 2024
1 parent 08cfc72 commit 1f44758
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,14 @@

This is a basic template for katas to be made in Golang.

Users can already fork this repository, but they will be able to submit their commits only once the battle has started.
Students can already fork this repository, but they will be able to submit their commits only once the battle has started.

## Submitting entries for the battle

The GitHub Action provided in this repository will automatically submit the compiled output for execution and test running in an automated way, and does not need modifications.

Since GitHub authorization is required to identify the committer and assign score to battle participant, students need to populate repository secrets with the value GITHUB_PAT, which is a Personal Access Token generated by them for their own GitHub account. The GitHub action to compile and submit artifacts will not run without a value for GITHUB_PAT. The API endpoint will error out for invalid or expired PATs.

Learn more about repository secrets [here](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions).

Learn more about Personal Access Tokens (PATs) [here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).

0 comments on commit 1f44758

Please sign in to comment.