Skip to content

Commit

Permalink
DEVPROD-5859 Remove commit queue docs (#8007)
Browse files Browse the repository at this point in the history
  • Loading branch information
@bsamek
bsamek authored Jun 18, 2024
1 parent 2d2b215 commit f9911ab
Show file tree
Hide file tree
Showing 11 changed files with 31 additions and 255 deletions.
5 changes: 1 addition & 4 deletions docs/CLI.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ After setting defaults, you can omit the flags and the default values will be us
Defaults may be changed at any time by editing your `~/.evergreen.yml` file.
Additionally, the default project for a directory is also tracked by the first successful patch or commit queue merge you perform in that directory. Symlinks are resolved to their absolute path. The defaults are maintained in the `~/.evergreen.yml` file, under the `projects_for_directory` key. The value for this key is a map, where the map keys are absolute paths, and the map values are project identifiers. The automatic defaulting can be disabled by setting disable_auto_defaulting to true.
Additionally, the default project for a directory is also tracked by the first successful patch you perform in that directory. Symlinks are resolved to their absolute path. The defaults are maintained in the `~/.evergreen.yml` file, under the `projects_for_directory` key. The value for this key is a map, where the map keys are absolute paths, and the map values are project identifiers. The automatic defaulting can be disabled by setting disable_auto_defaulting to true.
Prompts
---
Expand Down Expand Up @@ -376,9 +376,6 @@ evergreen last-green -p mci -v ubuntu
```
#### Commit Queue
The command `evergreen commit-queue` contains subcommands for interacting with the commit queue. See [Commit Queue](Project-Configuration/Commit-Queue).
#### Buildlogger Fetch
The command `evergreen buildlogger fetch` downloads logs from cedar buildlogger.
Expand Down
202 changes: 0 additions & 202 deletions docs/Project-Configuration/Commit-Queue.md
View file

This file was deleted.

8 changes: 4 additions & 4 deletions docs/Project-Configuration/Evergreen-Data-for-Analytics.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Daily aggregated statistics for task executions run in Evergreen. Tasks are aggr
| project\_id | VARCHAR | Unique project identifier.
| variant | VARCHAR | Name of the build variant on which the tasks ran.
| task\_name | VARCHAR | Display name of the tasks.
| request\_type | VARCHAR | Name of the trigger that requested the task executions. Will always be one of: `patch_request`, `github_pull_request`, `gitter_request` (mainline), `trigger_request`, `github_merge_request` (GitHub merge queue), `merge_test` (Evergreen commit queue), or `ad_hoc` (periodic build).
| request\_type | VARCHAR | Name of the trigger that requested the task executions. Will always be one of: `patch_request`, `github_pull_request`, `gitter_request` (mainline), `trigger_request`, `github_merge_request` (GitHub merge queue), `merge_test` (Evergreen commit queue, deprecated), or `ad_hoc` (periodic build).
| finish\_date | VARCHAR | Date, in ISO format `YYYY-MM-DD`, on which the tasks ran.
| num\_success | BIGINT | Number of successful task executions in the group.
| num\_failed | BIGINT | Number of failed task executions in the group.
Expand All @@ -52,7 +52,7 @@ Daily aggregated statistics for test executions run in Evergreen. Test stats are
| variant | VARCHAR | Name of the build variant on which the tests ran.
| task\_name | VARCHAR | Name of the task that the test ran under. This is the display task name for tasks that are part of a display task.
| test\_name | VARCHAR | Display name of the tests.
| request\_type | VARCHAR | Name of the trigger that requested the task execution. Will always be one of: `patch_request`, `github_pull_request`, `gitter_request` (mainline), `trigger_request`, `github_merge_request` (GitHub merge queue), `merge_test` (Evergreen commit queue), or `ad_hoc` (periodic build).
| request\_type | VARCHAR | Name of the trigger that requested the task execution. Will always be one of: `patch_request`, `github_pull_request`, `gitter_request` (mainline), `trigger_request`, `github_merge_request` (GitHub merge queue), `merge_test` (Evergreen commit queue, deprecated), or `ad_hoc` (periodic build).
| num\_pass | BIGINT | Number of passing tests.
| num\_fail | BIGINT | Number of failing tests.
| total\_pass\_duration\_ns | DOUBLE | Total duration, in nanoseconds, of passing tests.
Expand All @@ -76,7 +76,7 @@ Finished Evergreen tasks, partitioned by the project and date (in ISO format). F
| build\_id | VARCHAR | ID of the build containing the task.
| order | BIGINT | Order number of the task's version. For patches this is the user's current patch submission count. For mainline versions this is the number of versions for that repository so far.
| revision | VARCHAR | Git commit SHA.
| requester | VARCHAR | Name of the trigger that requested the task execution. Will always be one of: `patch_request`, `github_pull_request`, `gitter_request` (mainline), `trigger_request`, `github_merge_request` (GitHub merge queue), `merge_test` (Evergreen commit queue), or `ad_hoc` (periodic build).
| requester | VARCHAR | Name of the trigger that requested the task execution. Will always be one of: `patch_request`, `github_pull_request`, `gitter_request` (mainline), `trigger_request`, `github_merge_request` (GitHub merge queue), `merge_test` (Evergreen commit queue, deprecated), or `ad_hoc` (periodic build).
| tags | ARRAY(VARCHAR) | Array of task tags from project configuration.
| priority | BIGINT | Scheduling priority of the task.
| task\_group | VARCHAR | Name of the task group that contains this task.
Expand Down Expand Up @@ -172,7 +172,7 @@ Note that this is an estimated cost based solely on compute (`BoxUsage`) usage p
| display\_name | VARCHAR | Display name of the task, will be the parent task's display name if part of a display task.
| build\_variant | VARCHAR | Name of the task's build variant.
| build\_variant\_display\_name | VARCHAR | Display name of the task's build variant.
| requester | VARCHAR | Name of the trigger that requested the task execution. Will always be one of: `patch_request`, `github_pull_request`, `gitter_request` (mainline), `trigger_request`, `github_merge_request` (GitHub merge queue), `merge_test` (Evergreen commit queue), or `ad_hoc` (periodic build).
| requester | VARCHAR | Name of the trigger that requested the task execution. Will always be one of: `patch_request`, `github_pull_request`, `gitter_request` (mainline), `trigger_request`, `github_merge_request` (GitHub merge queue), `merge_test` (Evergreen commit queue, deprecated), or `ad_hoc` (periodic build).
| activated\_by | VARCHAR | User or service that activated this task.
| tags | ARRAY(VARCHAR) | Array of task tags from project configuration.
| host\_id | VARCHAR | ID of the host that ran this task.
Expand Down
17 changes: 3 additions & 14 deletions docs/Project-Configuration/Github-Integrations.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Specific GitHub pull request behavior can trigger behavior in Evergreen.
evergreen help
```

We have documentation here but we also provide it on the PR itself. It will display commands that are available for your project, with some context about when to use them. If the commit queue is disabled but there is an available message, we will still display the message. If PR testing isn't enabled for the branch but [PR testing is set up for untracked branches](../Project-Configuration/Repo-Level-Settings#how-to-use-pr-testing-for-untracked-branches) then we will also still show the related GitHub Pull request commands (detailed below).
We have documentation here but we also provide it on the PR itself. It will display commands that are available for your project, with some context about when to use them. If PR testing isn't enabled for the branch but [PR testing is set up for untracked branches](../Project-Configuration/Repo-Level-Settings#how-to-use-pr-testing-for-untracked-branches) then we will also still show the related GitHub Pull request commands (detailed below).

## GitHub Pull Request Testing

Expand All @@ -28,8 +28,6 @@ evergreen retry

Sometimes Evergreen has trouble creating a PR patch, due to internal server errors or GitHub flakiness. Commenting `evergreen retry` will attempt to recreate this patch. This can also be used to submit a new patch.

Note that this is specific to GitHub PR checks; it won't retry a commit queue patch. For that, re-type `evergreen merge` (detailed below).

#### Set PR patches to reuse a patch definition

```
Expand Down Expand Up @@ -81,18 +79,9 @@ Sometimes Evergreen has trouble sending updated GitHub statuses, so the checks o

GitHub only allows one set of statuses for every commit SHA. If you have a situation where you have two PRs where the HEAD commit is the same, Evergreen will only create a patch for the first one and will make a comment on the second one explaining why. In general, if your tasks do not require the context of the PR (most notably the branch name, which is known to be used in some s3.put tasks), then the status displayed for the PRs will be correct. If the tasks do require the context of the PR, you may comment 'evergreen retry' and force Evergreen to abort currently running patches in favor of a new one in the context of the PR you have commented on.

## Commit Queue

Evergreen's commit queue merges changes after the code has passed a set of tests. You can read more about this [here](Commit-Queue#commit-queue).

#### Add a PR to the commit queue

```
evergreen merge
<any text here will be added as the commit message>
```
## GitHub Merge Queue

To add a PR to the commit queue, comment `evergreen merge`. Any text after the newline will be added as the commit message.
See [GitHub Merge Queue](../Project-Configuration/Merge-Queue.md) for more information.

## Github Check Runs

Expand Down
Loading

0 comments on commit f9911ab

Please sign in to comment.