update readme

Akkjon · Jan 1, 2025 · 86c9ae7 · 86c9ae7
1 parent 155257b
commit 86c9ae7
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -19,6 +19,18 @@ A GitHub Action to remove a milestone by the milestone's name
 If the milestone should fail if the provided milestone is missing<br> Default:
 false
 
+## Environment Variables
+
+### `GITHUB_TOKEN`
+
+**Required** The access token with which the Action does the authentication with
+GitHub
+
+### `CLOSE_MILESTONE_REPOSITORY`
+
+If provided, this variable overrides the repository used to close the milestone
+for. It has to be provided in the format of `<owner>/<repository name>`
+
 ## Outputs
 
 ### `milestone_id`