From 1f44758b92ecee13704c5e6ae433f5ce0b534e12 Mon Sep 17 00:00:00 2001 From: Giovanni Orciuolo Date: Thu, 1 Feb 2024 18:14:54 +0100 Subject: [PATCH] Update README.md --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d635585..1782920 100644 --- a/README.md +++ b/README.md @@ -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).