From 0822ddfe079c46ff5a961307fa4c5ab8c9c0b120 Mon Sep 17 00:00:00 2001 From: Melonify <13710061+Melonify@users.noreply.github.com> Date: Mon, 14 Aug 2023 17:31:25 -0400 Subject: [PATCH] Add docs to GH Packages key scripts (#4) --- .documentation/Contributing.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.documentation/Contributing.md b/.documentation/Contributing.md index 186abde..55f523c 100644 --- a/.documentation/Contributing.md +++ b/.documentation/Contributing.md @@ -27,6 +27,8 @@ This repository provides multiple tools to make co-development of packages easie - `yarn dev:link-project `: Links all packages which the specified project depends on to the local versions in this repo, specify the `--all` option to link every package in this repo to the target project, even if they are not dependencies. - `yarn dev:unlink-project `: Unlinks all packages which were previously linked to the specified project from this repo, specify the `--skip-reinstall` parameter to avoid refetching live versions of the packages after unlinking, if this is skipped you may need to manually run `yarn install --check-files` to ensure any dangling or old links get dropped, and yarn fetches packages that are no longer linked. - `yarn dev:bump-project-locks `: Automatically bumps any dependency packages from this repo in the specified project's `yarn.lock` file, does not modify project manifest only bumps the static version the lockfile locks to, to the most recent one which now satisfies the dependency's constraints. +- `yarn gh-packages-key`: Append GitHub Packages read token to your local .npmrc, this allows you to fetch unresolvable packages if a package in this repository depends on a version which cannot be satisfied by the local versions at your HEAD. +- `yarn gh-packages-key:undo`: Removes GitHub Packages read token from your local .npmrc so you can commit the file if changes need to be made to the base .npmrc ## Workspaces