Skip to content

Commit 29a1be4

Browse files
committed
rewrite getting-started guide, since it doesnt require manual setup anymore 🙌 add note about fork support
1 parent 5d6178a commit 29a1be4

File tree

2 files changed

+21
-5
lines changed

2 files changed

+21
-5
lines changed

faq.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# FAQ
22

3+
## Q: Does it work with forks?
4+
5+
Yes! Forks are seamlessly supported, this feature is quite experimental right now but definitely
6+
working!
7+
38
## Q: How does codechecks relate to DangerJS?
49

510
DangerJS is a library, codechecks is a platform. This means many things but most importantly

getting-started.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,23 @@
11
# Getting started
22

3-
**Note: we are in close beta**
3+
**Note: we are in close beta — some APIs WILL change**
44

5-
First of all, contact us at [email protected] to get your secret code, needed to set up the
6-
project.
5+
First of all, you need to install Github CodeChecks app on repositories that you're interested using
6+
with CC.
77

8-
Install our Github app using this link: https://github.com/apps/codechecks Please install it only on
9-
repos that you really need (just for now).
8+
1. Log into our [web application](https://app.codechecks.io/) using Github.
9+
2. Click "Add new project" button
10+
3. You will be redirected back into Github interface where you need to select appropriate
11+
repositories.
12+
4. Once done you should be able to see all repositories within our app (if not please refresh). Note
13+
that in the right top corner you can switch between orgs.
14+
5. Copy secret using "copy" button and paste it as secret environment inside your CI interface:
15+
16+
```
17+
CC_SECRET=COPIED SECRET
18+
```
19+
20+
For now only CircleCI is supported.
1021

1122
In this mini tutorial we assume that you develop frontend app so we want to watch how build size is
1223
changing between PRs. We can use already existing codecheck:

0 commit comments

Comments
 (0)