willdot.net
docs: document default env vars in pipelines
Signed-off-by: oppiliappan <me@oppi.li>
oppi.li
+33
docs/DOCS.md
+33
docs/DOCS.md
···
693
693
MY_ENV_VAR: "MY_ENV_VALUE"
694
694
```
695
695
696
+
By default, the following environment variables set:
697
+
698
+
- `CI` - Always set to `true` to indicate a CI environment
699
+
- `TANGLED_PIPELINE_ID` - The AT URI of the current pipeline
700
+
- `TANGLED_REPO_KNOT` - The repository's knot hostname
701
+
- `TANGLED_REPO_DID` - The DID of the repository owner
702
+
- `TANGLED_REPO_NAME` - The name of the repository
703
+
- `TANGLED_REPO_DEFAULT_BRANCH` - The default branch of the
704
+
repository
705
+
- `TANGLED_REPO_URL` - The full URL to the repository
706
+
707
+
These variables are only available when the pipeline is
708
+
triggered by a push:
709
+
710
+
- `TANGLED_REF` - The full git reference (e.g.,
711
+
`refs/heads/main` or `refs/tags/v1.0.0`)
712
+
- `TANGLED_REF_NAME` - The short name of the reference
713
+
(e.g., `main` or `v1.0.0`)
714
+
- `TANGLED_REF_TYPE` - The type of reference, either
715
+
`branch` or `tag`
716
+
- `TANGLED_SHA` - The commit SHA that triggered the pipeline
717
+
- `TANGLED_COMMIT_SHA` - Alias for `TANGLED_SHA`
718
+
719
+
These variables are only available when the pipeline is
720
+
triggered by a pull request:
721
+
722
+
- `TANGLED_PR_SOURCE_BRANCH` - The source branch of the pull
723
+
request
724
+
- `TANGLED_PR_TARGET_BRANCH` - The target branch of the pull
725
+
request
726
+
- `TANGLED_PR_SOURCE_SHA` - The commit SHA of the source
727
+
branch
728
+
696
729
### Steps
697
730
698
731
The `steps` field allows you to define what steps should run