Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DEVPROD-8661 Document untracked branch tasks not having all expansions #8517

Merged
merged 2 commits into from
Dec 3, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions docs/Project-Configuration/Project-Configuration-Files.md
Original file line number Diff line number Diff line change
Expand Up @@ -777,14 +777,6 @@ Every task has some expansions available by default:
the base commit is the PR base chosen by GitHub.
- `${github_commit}` is the commit hash of the commit that triggered
the patch run
- `${project}` is the project identifier the task belongs to
- `${project_identifier}` is the project identifier the task belongs
to // we will be deprecating this, please use `${project}`
- `${project_id}` is the project ID the task belongs to (note that for
later projects, this is the unique hash, whereas for earlier
projects this is the same as `${project}`. If you aren't sure which
you are, you can check using this API route:
`https://evergreen.mongodb.com/rest/v2/<project_id>`)
- `${branch_name}` is the name of the branch tracked by the
project
- `${distro_id}` is name of the distro the task is running on
Expand Down Expand Up @@ -822,6 +814,18 @@ Every task has some expansions available by default:
- `${__project_aws_ssh_key_value}` is the unencrypted PEM encoded PKCS#1 private key
returned along with `${__project_aws_ssh_key_name}`.

The following expansions are available unless a task was from an
[untracked branch](Repo-Level-Settings.md#how-to-use-pr-testing-for-untracked-branches).

- `${project}` is the project identifier the task belongs to
- `${project_identifier}` is the project identifier the task belongs
to // we will be deprecating this, please use `${project}`
- `${project_id}` is the project ID the task belongs to (note that for
later projects, this is the unique hash, whereas for earlier
projects this is the same as `${project}`. If you aren't sure which
you are, you can check using this API route:
`https://evergreen.mongodb.com/rest/v2/<project_id>`)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I know it was already like this, but would be preferable to link this to the route's docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Linked it!


The following expansions are available if a task was triggered by an
inter-project dependency:

Expand Down
Loading