chore: add gitlab section to readme

defenseunicorns · Oct 16, 2024 · 3d75da1 · 3d75da1
1 parent b868ffd
commit 3d75da1
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -39,6 +39,10 @@ uds-releaser update-yaml <flavor>
 uds-releaser release <flavor>
 ```
 
+### Gitlab
+
+When running `uds-releaser release gitlab <flavor>` you are expected to have an environment variable set to a GitLab token that has write permissions for your current project. This defaults to `GITLAB_RELEASE_TOKEN` but can be changed with the `--token-var-name` flag.
+
 ## Configuration
 
 UDS-Releaser can be configured using a YAML file named uds-releaser.yaml in your project's root directory.