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

Mention ci-matrix in the main help message #314

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Pawka
Copy link
Contributor

@Pawka Pawka commented Mar 29, 2023

The gotestsum tool ci-matrix was not mentioned in the main help message. I have found this feature only accidentally :-)

Add the command to the main help message which is printed via gotestsum help:

$ gotestsum help
...
Commands:
    ./gotestsum tool ci-matrix   use previous test runtime to place packages into optimal buckets
    ./gotestsum tool slowest     find or skip the slowest tests
    ./gotestsum help             print this help next

@dnephin
Copy link
Member

dnephin commented Mar 29, 2023

Thank you for the PR! You're right this new tool is not yet documented in the help text or in the README. I have it on the list of things to do in #287.

I have been hesitant to document this new tool because I'm not sure if the design is correct. #287 has a number of improvements, but I'm also interested in finding a way to avoid the first "matrix building" step. That can add 30s+ to the total runtime, which negates some of the benefit gained by running tests in parallel.

I'm going to hold off on merging this PR until the tool settles a bit. I believe there is at least one large project using the current tool. If you end up using ci-matrix I would love your feedback about it, especially if you are able to use it with buildkite or some other CI system.

@Pawka
Copy link
Contributor Author

Pawka commented Mar 30, 2023

Totally makes sense! I though it simply was forgotten to be added :-) Thank you for explaining.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants