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): use assignment rules with self provisioned agents #29490

Merged
merged 7 commits into from
Jan 17, 2025

Conversation

lourw
Copy link
Contributor

@lourw lourw commented Dec 30, 2024

Current Behavior

The initial version of the docs only allow the use of assignment rules with Nx Agents.

Expected Behavior

The updated docs include an overview and example of how to configure assignment rules to work with self provisioned agents (and DTE in 'manual' mode).

Related Issue(s)

Fixes #

@lourw lourw requested review from StalkAltan, rarmatei, nixallover and a team as code owners December 30, 2024 15:50
Copy link

vercel bot commented Dec 30, 2024

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

Name Status Preview Updated (UTC)
nx-dev ✅ Ready (Inspect) Visit Preview Jan 17, 2025 7:18am

@lourw lourw changed the title docs(nx-cloud): use assignment rules with manual DTE docs(nx-cloud): use assignment rules with self provisioned agents Dec 30, 2024
Copy link

nx-cloud bot commented Dec 30, 2024

View your CI Pipeline Execution ↗ for commit 9bc0cfa.

Command Status Duration Result
nx affected --targets=lint,test,build,e2e,e2e-c... ✅ Succeeded 3m 33s View ↗
nx run-many -t check-imports check-commit check... ✅ Succeeded 52s View ↗
nx-cloud record -- nx-cloud conformance:check ✅ Succeeded 1s View ↗
nx-cloud record -- nx format:check --base=cba25... ✅ Succeeded 21s View ↗
nx-cloud record -- nx sync:check ✅ Succeeded 20s View ↗
nx documentation --no-dte ✅ Succeeded 39s View ↗

☁️ Nx Cloud last updated this comment at 2025-01-17 07:18:24 UTC

@lourw lourw force-pushed the lourw/assignment-rules-manual-dte branch from 89afb18 to eda7547 Compare January 16, 2025 23:14
@lourw lourw force-pushed the lourw/assignment-rules-manual-dte branch from eda7547 to 66e357b Compare January 16, 2025 23:17
@lourw
Copy link
Contributor Author

lourw commented Jan 16, 2025

@isaacplmann I added some more details and edited some of the grammar. Can I just get one more once-over from you?

Comment on lines 29 to 30
{% callout type="note" title="If you are using self-hosted agents, you must define your own agent types" %}
You can define your own agent types and attach them to your self-hosted agents using the `NX_AGENT_LAUNCH_TEMPLATE` environment variable. Ensure that for each `runs-on` field in your assignment rules, you have corresponding agents in your agent pool that have the same agent type.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is it "you must" or "you can"? One of these needs to be changed

docs/nx-cloud/reference/assignment-rules.md Outdated Show resolved Hide resolved
@lourw lourw enabled auto-merge (squash) January 17, 2025 07:09
@lourw lourw merged commit bb03ed7 into master Jan 17, 2025
5 of 6 checks passed
@lourw lourw deleted the lourw/assignment-rules-manual-dte branch January 17, 2025 07:17
FrozenPandaz pushed a commit that referenced this pull request Jan 17, 2025
…9490)

<!-- 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 -->

The initial version of the docs only allow the use of assignment rules
with Nx Agents.

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

The updated docs include an overview and example of how to configure
assignment rules to work with self provisioned agents (and DTE in
'manual' mode).

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

Fixes #

---------

Co-authored-by: Isaac Mann <[email protected]>
(cherry picked from commit bb03ed7)
FrozenPandaz pushed a commit that referenced this pull request Jan 22, 2025
…9490)

<!-- 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 -->

The initial version of the docs only allow the use of assignment rules
with Nx Agents.

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

The updated docs include an overview and example of how to configure
assignment rules to work with self provisioned agents (and DTE in
'manual' mode).

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

Fixes #

---------

Co-authored-by: Isaac Mann <[email protected]>
(cherry picked from commit bb03ed7)
Copy link

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 Jan 23, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants