Skip to content
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.

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

chore(analytics): add Scarf to npm install, docs, and ui #725

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/unused-dependencies.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
node-version: '18.x'
- name: 'Run depcheck'
run: |
npx depcheck --skip-missing --ignores="@babel/*,@commitlint/*,eslint,eslint-*,husky,mocha,concurrently,nyc,prettier"
npx depcheck --skip-missing --ignores="@babel/*,@commitlint/*,eslint,eslint-*,husky,mocha,concurrently,nyc,prettier,@scarf/scarf"
echo $?
if [[ $? == 1 ]]; then
echo "Unused dependencies or devDependencies found"
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
<div align="center">
<a href="https://github.com/finos/git-proxy">
<img src="./docs/img/logo.png" alt="Logo" height="95">
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=a51b8999-4347-442c-bc98-bfcc380ee280" />
</a>

<br />
Expand Down
7 changes: 7 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
"@material-ui/core": "^4.11.0",
"@material-ui/icons": "4.11.3",
"@primer/octicons-react": "^19.8.0",
"@scarf/scarf": "^1.3.0",
"@seald-io/nedb": "^4.0.2",
"axios": "^1.6.0",
"bcryptjs": "^2.4.3",
Expand Down Expand Up @@ -116,5 +117,10 @@
"last 1 firefox version",
"last 1 safari version"
]
},
"scarfSettings": {
"enabled": true,
"allowTopLevel": true,
"skipTraversal": false
}
}
1 change: 1 addition & 0 deletions src/ui/components/Footer/Footer.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ export default function Footer(props) {
<span>&copy; {1900 + new Date().getYear()} GitProxy</span>
</p>
</div>
<img referrerPolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=afd0e5de-d4dc-42e3-bb72-6fc64323c5d0" />
</footer>
);
}
2 changes: 2 additions & 0 deletions website/docs/configuration/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Overview
description: How to customise push protections and policies
---

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=a51b8999-4347-442c-bc98-bfcc380ee280" />

### Default configuration

On installation, GitProxy ships with an [out-of-the-box configuration](https://github.com/finos/git-proxy/blob/main/proxy.config.json). This is fine for
Expand Down
2 changes: 2 additions & 0 deletions website/docs/configuration/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Schema Reference
description: JSON schema reference documentation for GitProxy
---

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=a51b8999-4347-442c-bc98-bfcc380ee280" />

# Schema Reference

**Title:** GitProxy configuration file
Expand Down
4 changes: 3 additions & 1 deletion website/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
title: Introduction
---

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=a51b8999-4347-442c-bc98-bfcc380ee280" />

### What is GitProxy?

GitProxy deploys custom push protections and policies on top of Git. It is a highly configurable framework allowing developers and organizations to enforce push protections relevant to their developer workflow, security posture and risk appetite.

GitProxy is built with a developer-first mindset. By presenting simple-to-follow remediation instructions in the CLI/Terminal, it minimises the friction of use and adoption, and keeps developers focused on what matters; committing and pushing code.
GitProxy is built with a developer-first mindset. By presenting simple-to-follow remediation instructions in the CLI/Terminal, it minimises the friction of use and adoption, and keeps developers focused on what matters; committing and pushing code.
2 changes: 2 additions & 0 deletions website/docs/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Installation
description: How to install GitProxy in your environment
---

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=a51b8999-4347-442c-bc98-bfcc380ee280" />

### Install via [npm](https://www.npmjs.com/package/@finos/git-proxy)

To install GitProxy, you must first install [Node.js](https://nodejs.org/en/download). Then, use the [npm package manager](https://www.npmjs.com/):
Expand Down
2 changes: 2 additions & 0 deletions website/docs/quickstart/approve.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Approving a push
description: How to approve a push in GitProxy
---

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=a51b8999-4347-442c-bc98-bfcc380ee280" />

All pushes that flow through GitProxy require an approval (authorisation). Until a push is approved, GitProxy will block the commits from being sent to the upstream repository. To approve a push, you can use the REST API or web UI.

## Using the REST API
Expand Down
2 changes: 2 additions & 0 deletions website/docs/quickstart/intercept.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Intercepting a push
description: How to intercept a push with GitProxy
---

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=a51b8999-4347-442c-bc98-bfcc380ee280" />

In this section, we will demonstrate the power 💪 of GitProxy and how it works with a barebones & out-of-the-box demonstration using default configuration. Before we start, there are a few prerequisites:

### Prerequisites
Expand Down
Loading
Loading