39 Commits

Author SHA1 Message Date
Jack Hsu
28b48ad1f3
docs(misc): update URls that should point to intro pages rather than API index pages (#31531)
This PR fixes an issue introduced when we removed `/nx-api` pages:
https://github.com/nrwl/nx/pull/31453.

Most of the old `/nx-api/<plugin>` URLs should now go to
`/technologies/<plugin>/introduction`, since those pages contain what
was on the previous "overview" pages.

The only exception are places where we explicitly link to
`.../api/{generators,executors,migrations}` URLs, and the following
three blog posts that we want users to land on the API index.

-
https://github.com/nrwl/nx/blob/master/docs/blog/2022-03-29-the-react-cli-you-always-wanted-but-didnt-know-about.md?plain=1#L132
(https://nx.dev/blog/the-react-cli-you-always-wanted-but-didnt-know-about)
-
https://github.com/nrwl/nx/blob/master/docs/blog/2022-04-08-what-is-new-in-nx-13-10.md?plain=1#L245
(https://nx.dev/blog/what-is-new-in-nx-13-10)
-
https://github.com/nrwl/nx/blob/master/docs/blog/2022-05-02-nx-v14-is-out-here-is-all-you-need-to-know.md?plain=1#L253
(https://nx.dev/blog/nx-v14-is-out-here-is-all-you-need-to-know)
2025-06-10 15:08:29 -04:00
Jack Hsu
66eaf2fc74
docs(misc): remove /nx-api pages (#31453)
This PR removes the `/nx-api` pages from `nx-dev`. They are already
redirected from `/nx-api` to either `/technologies` or
`/reference/core-api` URLs.

e.g. `/nx-api/nx` goes to `/reference/core-api/nx` and `/nx-api/react`
goes to `/technologies/react/api`

**Changes**:
- Remove old `nx-api.json` from being generated in
`scripts/documentation/generators/generate-manifests.ts` -- this was
used to generate the sitemap
- Remove `pages/nx-api` from Next.js app since we don't need them
- Remove workaround from link checker
`scripts/documentation/internal-link-checker.ts` -- the angular
rspack/rsbuild and other workarounds are gone now that they are proper
docs in `map.json`
- Update Powerpack/Remote Cache reference docs to exclude API documents
(since they are duplicated in the Intro page) --
`nx-dev/models-document/src/lib/mappings.ts`
- All content in `docs` have been updated with new URL structure

**Note:** Redirects are already handled, and Claude Code was used to
verify the updated `docs/` URLs (see report below). The twelve 404s
links were updated by hand.

## Verification Report

https://gist.github.com/jaysoo/c7863fe7e091cb77929d1976165c357a
2025-06-04 16:57:01 -04:00
James Henry
9dcab79b10
feat(release)!: support gitlab releases (#30802) 2025-04-30 12:41:03 +04:00
James Henry
ee097a8e10
feat(release)!: useLegacyVersioning is false by default, migrate config (#30838)
This PR updates `nx release` to use the revamped versioning
implementation by default. It also updates and adds relevant
documentation, and provides an automated migration for the new
configuration structure.

For anyone exclusively versioning TS/JS packages, there should be no
real difference to your experience (although a number of bugs have been
fixed and new features around updating multiple `package.json` files at
once are now available to you with this change).

For the lifecycle of Nx v21, `release.version.useLegacyVersioning` will
remain as a option that can be set to `true` to revert to the old
behavior and configuration structure.

NOTE: This should only be a temporary solution, for example if one of
the plugins you use does provide a `VersionActions` based versioning
implementation yet. The option and legacy implementation will be removed
entirely in Nx v22 (in ~6 months).

BREAKING CHANGE:

**⚠️ For any early adopters of `VersionActions` in Nx 20.8 when it was
opt-in, there are breaking changes to the abstract class here as well.**

`manifestRootsToUpdate` has gone from `string[]` to `manifestsToUpdate:
{ manifestPath: string; preserveLocalDependencyProtocols: boolean; }[]`
to support controlling the local dependency updates per manifest in
order to support advanced source vs dist scenarios, and correspondingly
`isLocalDependencyProtocol` has been removed from the abstract class and
the method will no longer be called from the core logic. It should be
thought of as an implementation detail of `updateProjectDependencies`
instead.
2025-04-24 22:09:38 -04:00
Miroslav Jonaš
d4ebf82ac8
feat(core): add filter for git checkouts in generated pipelines and docs (#30547)
This PR adds Git filter `tree:0` to Azure and GitHub pipelines to avoid
fetching the full history content because of the affected command.

The change is made to:
- `ci-workflow` generator in `workspace` project for Azure and GitHub
- `ci-workflow` generator in `gradle` project for GitHub
- this repo's  main pipeline -`ci.yaml`
- all documentation occurrences where fetch depth 0 is used on Azure or
GitHub

More info on reasoning here:
https://github.blog/open-source/git/get-up-to-speed-with-partial-clone-and-shallow-clone/

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

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

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

Fixes #
2025-04-10 11:33:31 +02:00
Juri
437bad4aac docs(misc): add description frontmatter for better SEO 2025-03-04 16:58:14 +01:00
Steven Nance
44e7b41c4f
docs(release): document __INVALID__ conventional commit type (#30124) 2025-02-26 13:24:59 +04:00
James Henry
443d4fd27a
feat(core): support bun's new text-based lockfile and use bun publish within nx release (#30064) 2025-02-19 13:42:35 +04:00
Juri
041cecd6ff docs(release): link epic web nx release course 2025-02-05 16:22:51 +01:00
Laney
d0078d050e
docs(release): fix typo in version.generatorOptions.updateDependen… (#29640)
…ts option

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

The version generator option `updateDependents` is misspelled as
`updatedDependents` in one of the Nx release docs pages.

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

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

Fixes #
2025-01-16 10:21:44 +01:00
James Henry
0af50a9f9d
docs(release): cover version reference updates in greater detail (#29259) 2024-12-10 15:19:27 +04:00
Isaac Mann
fdc09fbf68
docs(core): remove quoted terms in content (#29266)
Remove quoted terms in the form \`"term"\` from the docs
2024-12-09 11:14:41 -05:00
Juri Strumpflohner
d8f9161f85
docs(release): small update to make phases of version plan stand out more (#28875) 2024-11-14 19:54:10 +04:00
Thu Vo
bd40a56e19
docs(release): version prefix dependents (#28729) 2024-11-06 14:57:25 +04:00
Jonathan Gelin
71fe65ffbd
feat(release): support groupPreVersionCommand for release groups (#27474) 2024-09-17 14:23:08 +04:00
James Henry
a9beb62b0d
docs(nx-dev): explicit callout for plan:check in CI (#27784) 2024-09-09 12:14:37 +02:00
Austin Fahsl
3d8c3ed4b5
docs(release): add recipe for preVersionCommand (#27782)
Adds a recipe for using `release.preVersionCommand` to ensure packages
are built before they are versioned.
2024-09-05 13:31:36 -06:00
James Henry
f1ecad0a8e
docs(release): file based versioning, version plans (#27428)
<!-- 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 -->

Version plans, stable in the imminent `19.6.0` release, is undocumented.

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

Version plans is a documented feature.

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

Fixes #

---------

Co-authored-by: Isaac Mann <isaacplmann@users.noreply.github.com>
2024-08-15 10:49:58 -04:00
Juri
04af849c66 docs(release): optimize the customize semver recipe 2024-08-07 08:24:58 -07:00
James Henry
ee2c41b75d
feat(release): allow {releaseGroupName} to be interpolated in releaseTagPattern (#27190) 2024-07-30 01:55:06 +04:00
James Henry
9e6c7fa6e3
Revert "feat(release): allow {releaseGroupName} to be interpolated in releaseTagPattern" (#27189)
Reverts nrwl/nx#27188
2024-07-29 20:31:43 +04:00
James Henry
0b9672b4e6
feat(release): allow {releaseGroupName} to be interpolated in tag pattern (#27188) 2024-07-29 20:31:17 +04:00
James Henry
c02f254316
docs(release): document github authentication logic and requirements (#27183) 2024-07-29 08:41:54 -04:00
James Henry
3a2e8d45f5
feat(release): allow disabling GitHub username matching in default changelog renderer (#26672) 2024-06-25 13:46:15 -04:00
Austin Fahsl
ebfd4b75ba
docs(release): publish from dist directory recipe (#26370) 2024-06-07 15:55:23 +04:00
Piotr Kuczynski
7611671994
docs(release): add configure changelogs (#23324)
## Current Behavior
Documentation is missing

## Expected Behavior
Documentation should be there...

---------

Co-authored-by: Isaac Mann <isaacplmann@gmail.com>
2024-05-14 09:51:26 -04:00
Austin Fahsl
12afa20210
fix(release): respect root .npmrc registry settings for publishing 2024-04-02 13:53:14 -06:00
Austin Fahsl
cbb88f0d29
feat(release): add conventional commits configurability for version and changelog (#22004)
Co-authored-by: Isaac Mann <isaacplmann@users.noreply.github.com>
2024-03-13 18:19:24 -06:00
Austin Fahsl
38179ad278
feat(js): replace publish script with nx release config (#21474) 2024-03-05 17:53:07 -05:00
James Henry
f27ea85bc7
docs(release): document nx release for rust crates (#22072) 2024-03-01 08:54:23 -05:00
Miroslav Jonaš
ecf70adbce
fix(core): align terminal output padding and remove leading arrow (#21809) 2024-02-20 17:43:46 +01:00
Austin Fahsl
c9c2d978e6
docs(release): introduction to github releases with nx release (#21814) 2024-02-15 08:06:00 -07:00
James Henry
30d10d72f7
Revert "feat(core): remove leading arrow from output headlines" (#21800) 2024-02-13 09:40:24 -05:00
Miroslav Jonaš
c2a09c5043
feat(core): remove leading arrow from output headlines (#21359) 2024-02-13 09:11:39 -05:00
Miroslav Jonaš
3ead01987b
fix(nx-dev): remove fence from new packages and "nx add" commands (#21705) 2024-02-08 14:43:50 +01:00
Isaac Mann
61436a64ef
docs(core): inferred targets (#21167)
Co-authored-by: Katerina Skroumpelou <mandarini@users.noreply.github.com>
Co-authored-by: Colum Ferry <cferry09@gmail.com>
Co-authored-by: Emily Xiong <xiongemi@gmail.com>
Co-authored-by: Nicholas Cunningham <ndcunningham@gmail.com>
Co-authored-by: Jason Jean <jasonjean1993@gmail.com>
Co-authored-by: Victor Savkin <mail@vsavkin.com>
Co-authored-by: Jack Hsu <jack.hsu@gmail.com>
2024-02-03 00:14:05 -05:00
orig
2a0dec8253
docs(misc): fixed a typo on nx-release recipe (#21453) 2024-01-31 12:20:18 -05:00
Austin Fahsl
5369f5d527
docs(release): add recipe for publishing in github actions (#21370) 2024-01-29 08:10:05 -07:00
Austin Fahsl
d9c53e14fc
chore(release): add nx release recipes (#21294) 2024-01-24 14:33:39 -07:00