Find a good commit to base your work on
Project description
git-co-evg-base
Find and checkout a recent git commit that matches the specified criteria.
Table of contents
Description
When running an Evergreen patch build, it can be useful that base your changes on a commit in which the tests in Evergreen have already been run. This way if you encounter any failures in your patch build, you can easily compare the failure with what was seen in the base commit to understand if your changes may have introduced the failure.
This command allows you to specify criteria to use to find and checkout a git commit to start work from.
Documentation
Documentation can be found here.
Dependencies
- Python 3.8 or later
- git
- Evergreen config file
Installation
We strongly recommend using a tool like pipx to install this tool. This will isolate the dependencies and ensure they don't conflict with other tools.
$ pipx install git-co-evg-base
Usage
Detailed usage documentation can be found here.
Usage: git-co-evg-base [OPTIONS]
Find and checkout a recent git commit that matches the specified criteria.
When running an Evergreen patch build, it can be useful that base your changes on a commit in
which the tests in Evergreen have already been run. This way if you encounter any failures in
your patch build, you can easily compare the failure with what was seen in the base commit to
understand if your changes may have introduced the failure.
This command allows you to specify criteria to use to find and checkout a git commit to start
work from.
Criteria:
There are 4 criteria that can be specified:
* The percentage of tasks that have passed in each build.
* The percentage of tasks that have run in each build.
* Specific tasks that must have passed in each build (if they are part of that build).
* Specific tasks that must have run in each build (if they are part of that build).
If not criteria are specified, a success threshold of 0.95 will be used.
Additionally, you can specify which build variants the criteria should be checked against. By
default, only builds that end in 'required' will be checked.
Notes:
If you have any evergreen modules with local checkouts in the location specified in your
project's evergreen.yml configuration file. They will automatically be checked out to the
revision that was run in Evergreen with the revision of the base project.
Examples:
Working on a fix for a task 'replica_sets' on the build variants 'enterprise-rhel-80-64-bit' and
'enterprise-windows', to ensure the task has been run on those build variants:
git co-evg-base --run-task replica_sets --build-variant enterprise-rhel-80-64-bit --build-variant --enterprise-windows
Starting a new change, to ensure that there are no systemic failures on the base commit:
git co-evg-base --pass-threshold 0.98
Options:
--passing-task TEXT Specify a task that needs to be passing (can be specified
multiple times).
--run-task TEXT Specify a task that needs to be run (can be specified multiple
times).
--run-threshold FLOAT Specify the percentage of tasks that need to be run.
--pass-threshold FLOAT Specify the percentage of tasks that need to be successful.
--evg-config-file PATH File containing evergreen authentication information.
--evg-project TEXT Evergreen project to query against.
--build-variant TEXT Regex of Build variants to check (can be specified multiple
times).
--commit-lookback INTEGER Number of commits to check before giving up
--timeout-secs INTEGER Number of seconds to search for before giving up.
--commit-limit TEXT Oldest commit to check before giving up.
--git-operation [checkout|rebase|merge|none]
Git operations to perform with found commit [default=checkout].
-b, --branch TEXT Name of branch to create on checkout.
--save-criteria TEXT Save the specified criteria rules under the specified name for
future use.
--use-criteria TEXT Use previously save criteria rules.
--list-criteria Display saved criteria.
--override Override saved conflicting save criteria rules.
--export-criteria TEXT Specify saved criteria to export to a file.
--export-file PATH File to write exported rules to.
--import-criteria PATH Import previously exported criteria.
--output-format [plaintext|yaml|json]
Format of the command output [default=plaintext].
--verbose Enable debug logging.
--help Show this message and exit.
Checkout using the default criteria:
$ git co-evg-base
Checkout with successful tasks 'auth' and 'auth_audit' on builds 'enterprise-windows' and 'enterprise-rhel-80-64-bit' and 95% of the tasks are passing.
$ git co-evg-base --passing-task auth --passing-task auth_audit --run-threshold 0.95 --build-variant enterprise-windows --build-variant enterprise-rhel-80-64-bit
Contributor's Guide
Setting up a local development environment
This project uses poetry for setting up a local environment.
git clone ...
cd ...
poetry install
linting/formatting
This project uses black and isort for formatting.
poetry run black src tests
poetry run isort src tests
Running tests
This project uses pytest for testing.
poetry run pytest
Automatically running checks on commit
This project has pre-commit configured. Pre-commit will run configured checks at git commit time. To enable pre-commit on your local repository run:
poetry run pre-commit install
Versioning
This project uses semver for versioning.
Please include a description what is added for each new version in CHANGELOG.md
.
Code Review
Please open a Github Pull Request for code review.
Deployment
Deployment to pypi is automatically triggered on merges to master.
Resources
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for git_co_evg_base-0.5.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d730dfb313b710cf9a3d7d2af1f31e2925a400c722e81480bb4a0303186dfa43 |
|
MD5 | 7f927797d213eadc7f68b2292afa569a |
|
BLAKE2b-256 | 7dc5b2acd914fdc1957e30942df84a39ae31c32c4cecc0f3242e3910fb11d16d |