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

docs(nx-cloud): update reference to start-ci-run and complete-ci-run #27909

Merged
merged 1 commit into from
Sep 25, 2024

Conversation

lourw
Copy link
Contributor

@lourw lourw commented Sep 13, 2024

Current Behavior

Expected Behavior

Updated references about start-ci-run to include mentions of warnings that you get if you don't include the --distribute-on flag.

Also removed references to the legacy --stop-all-agents command in favor of --complete-ci-run.

Related Issue(s)

Fixes #

Copy link

vercel bot commented Sep 13, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
nx-dev ✅ Ready (Inspect) Visit Preview Sep 24, 2024 5:20pm

@lourw lourw marked this pull request as ready for review September 13, 2024 16:29
@lourw lourw requested review from StalkAltan, rarmatei and a team as code owners September 13, 2024 16:29
Copy link
Collaborator

@isaacplmann isaacplmann left a comment

Choose a reason for hiding this comment

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

Approved with a suggestion to reorder some text. You'll be able to make the change and immediately merge.

@@ -80,14 +80,13 @@ You can configure your CI run by passing the following flags:

### --distribute-on

Tells Nx Cloud how many agents to use (and what launch templates to use) to distribute tasks. E.g.,
By default, `npx nx-cloud start-ci-run` is intended for use with [Nx Agents](/ci/features/distribute-task-execution) and expects `--distribute-on` to be configured. It will output a warning if this flag is not set. If you are running a distributed execution with a legacy setup without Nx Agents, you can pass `--distribute-on=manual` to disable this warning.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Move this paragraph to be the second paragraph in this section. The definition of the flag should be the first paragraph and then this caveat paragraph

Copy link
Contributor Author

@lourw lourw Sep 25, 2024

Choose a reason for hiding this comment

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

Aw crud didn't see this comment before I merged. Will make another PR 🤦

@lourw lourw merged commit 4fe7cbe into master Sep 25, 2024
6 checks passed
@lourw lourw deleted the lourw/update-ci-docs branch September 25, 2024 15:06
FrozenPandaz pushed a commit that referenced this pull request Sep 26, 2024
…27909)

<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
<!-- This is the behavior we have today -->

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

Updated references about start-ci-run to include mentions of warnings
that you get if you don't include the `--distribute-on` flag.

Also removed references to the legacy `--stop-all-agents` command in
favor of `--complete-ci-run`.

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #
Copy link

github-actions bot commented Oct 1, 2024

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants