-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(setup.md): move setup section from readme to docs folder
- Loading branch information
1 parent
c197ba0
commit c516ef2
Showing
4 changed files
with
61 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,9 @@ | ||
# Monorepo Documentation | ||
|
||
[Additional Commands](COMMANDS.md) | ||
|
||
[Architecture](ARCHITECTURE.md) | ||
|
||
[Additional Commands](COMMANDS.md) | ||
[Setup](SETUP.md) | ||
|
||
[Workspace Commands](WORKSPACE.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Repository Setup | ||
|
||
## Tokens | ||
|
||
### NX | ||
|
||
Follow the directions [here](https://nx.dev/nx-cloud/set-up) to set up an `nx` account. | ||
|
||
Follow the directions [here](https://nx.dev/nx-cloud/account/access-tokens) to set up an `nx` access token. | ||
|
||
Create an `nx-cloud.env` file with the following to enable cloud caching: | ||
|
||
```bash | ||
NX_CLOUD_ACCESS_TOKEN=your-token | ||
``` | ||
|
||
### Github and NPM | ||
|
||
Create a `GH_TOKEN` personal access token [here](https://github.com/settings/tokens) and create an `NPM_TOKEN` [here](https://www.npmjs.com/login) via the `Access Tokens` section. | ||
|
||
Set up your `NPM_TOKEN` and `NX_CLOUD_ACCESS_TOKEN` via `Settings` -> `Secrets` -> `Actions`. | ||
|
||
## Repository Permissions | ||
|
||
### Github | ||
|
||
Enable read and write workflow permissions in your repo via `Settings` -> `Actions` -> `General` -> `Workflow permissions` -> `read and write permissions`. | ||
|
||
### Renovate | ||
|
||
Go to `Option` and activate at least `Allow auto-merge` and `Automatically delete head branches` | ||
|
||
Go to `Branches` and add a branch protection rule for your `main` branch. Activate `Require status checks to pass before merging` and `Require branches to be up to date before merging` | ||
|
||
## NX Distributed Caching | ||
|
||
To enable nx distributed caching, refactor the `.github/workflows/release.yml` file via the directions [here](https://nx.dev/recipes/ci/monorepo-ci-github-actions#distributed-ci-with-nx-cloud). |