Skip to content

Commit

Permalink
fix(repo): minor updates
Browse files Browse the repository at this point in the history
  • Loading branch information
waldronmatt committed Nov 14, 2023
1 parent 5504ce9 commit 2152555
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions docs/repo/COMMANDS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Delete workspace root `node_modules` and `pnpm-lock.yaml` files:

**Note**: Install `rimraf` globally and make sure it is not installed in the workspace root so errors aren't thrown.
**Note**: Follow the directions [here](SETUP.md#global-packages) to install `rimraf` globally so errors aren't thrown.

```bash
pnpm delete
Expand Down Expand Up @@ -34,7 +34,7 @@ pnpm preview:diff

Preview the output result of the `version` command without actually executing it:

**Note**: Set your GitHub access token as a system/os-level environment variable in your operating system as `GITHUB_TOKEN` with the token unique identifier as the value.
**Note**: Follow the directions [here](SETUP.md#lerna) to set up a `GITHUB_TOKEN` environment variable in your operating system.

```bash
pnpm preview:version
Expand Down
4 changes: 2 additions & 2 deletions docs/repo/SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ Set up `NX_CLOUD_ACCESS_TOKEN` in GitHub via `Settings` -> `Secrets` -> `Actions

## Lerna

Follow the directions to set up a `GITHUB_TOKEN` [here](https://github.com/lerna-lite/lerna-lite/blob/main/packages/version/README.md#remote-client-auth-tokens) to allow Lerna to create GitHub tags and releases.
Follow the directions to set up a `GITHUB_TOKEN` [here](https://github.com/lerna-lite/lerna-lite/blob/main/packages/version/README.md#remote-client-auth-tokens) with `repo:public_repo` scope to allow Lerna to create GitHub tags and releases.

Additionally, you can set up `GITHUB_TOKEN` as an environment variable in your os so you can run Lerna commands via the terminal.
Next, set up `GITHUB_TOKEN` as an environment variable in your operating system so you can run Lerna commands via the terminal.

Create an `NPM_TOKEN` [here](https://www.npmjs.com/login) as type `Automation` via the `Access Tokens` section to allow Lerna to publish packages to NPM.

Expand Down
2 changes: 1 addition & 1 deletion docs/repo/TOOLS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

[`nx`](https://github.com/nrwl/nx): Task runner with great performance for small and large sized monorepos and many tooling options for different tech stacks

[`lerna-lite`](https://github.com/lerna-lite/lerna-lite): Publisher that supports conventional commits for semantic versioning and is smaller and more lightweight than `lerna`
[`lerna-lite`](https://github.com/lerna-lite/lerna-lite): Publisher that supports conventional commits for versioning and is smaller and more lightweight than Lerna

## Workspace Tooling

Expand Down
10 changes: 5 additions & 5 deletions docs/repo/WORKSPACE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@
Install an exact version of a dependency to the root of the workspace:

```bash
pnpm add -w prettier -E
pnpm add -w -E prettier
```

Add a package as a dependency for local package:
Add an exact version of a package as a dependency for local package:

```bash
pnpm add react -E --filter vite-project
pnpm add -E react --filter vite-project
```

Add a **local** package and another package as a development dependency for local package:
Add an exact version of a **local** package and another package as a development dependency for local package:

```bash
pnpm add -D eslint-config-custom --workspace eslint --filter vite-project
pnpm add -D -E eslint-config-custom --workspace eslint --filter vite-project
```

## Remove Packages
Expand Down

0 comments on commit 2152555

Please sign in to comment.