Skip to content

Commit 36c6d8e

Browse files
author
Szymon Janikowski
committed
Remark about the branch configuration in the quick start test
1 parent 68e388b commit 36c6d8e

2 files changed

Lines changed: 17 additions & 0 deletions

File tree

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,3 +83,6 @@ jspm_packages/
8383

8484
# TernJS port file
8585
.tern-port
86+
87+
# IntelliJ Idea - jetbrains ides files
88+
.idea

docs/quick-start.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,20 @@ Check if the project correctly compiles - otherwise Noesis won't be able to work
170170
dotnet build
171171
```
172172

173+
:::info Branch configuration
174+
If the project you configured has a default branch named something other than *main*, you must specify the branch name as the third argument in the system config.
175+
```csharp
176+
public static FullAnalysisConfig Create() => FullAnalysisConfigBuilder
177+
.System("My System") // System name in documentation
178+
.Repositories(repositories => repositories
179+
// Configured "develop" as a scanned branch
180+
.UseLocal("Main", "my-system-repo", "develop"))
181+
//(...)
182+
.Build();
183+
```
184+
**Important**: when the repository path references a local directory, **the branch must already be checked out from the remote** before launching the scanner—it won't check out the branch from origin for you. This is only possible if you have configured a remote repository link with a Personal Access Token.
185+
:::
186+
173187

174188
### 4.4: Run with Module Configuration
175189
Navigate back to noesis-workspace

0 commit comments

Comments
 (0)