Skip to content

docs: install a local checkout #649

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jul 25, 2024
Merged

docs: install a local checkout #649

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a852c9
Install a local checkout
maoo Jul 17, 2024
02b4c5f
Merge branch 'main' into maoo-patch-2
JamieSlome Jul 25, 2024
0f59678
Merge branch 'main' into maoo-patch-2
JamieSlome Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions website/docs/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,17 @@ To install a specific version of the GitProxy CLI, append the version to the end
```bash
npm install -g @finos/[email protected]
```

### Install a local checkout

To test a personal fork, or the latest version of the main branch:

```bash
git clone [email protected]:finos/git-proxy.git
cd git-proxy
npm pack
npm i -g finos-git-proxy-<version>.tar.gz
git-proxy --version
```

To make sure that the `git-proxy` command is using your checked out version, update the `version` in `package.json` before running `npm pack`, then verify that the same version is returned when running `git-proxy --version`.
Loading