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

Update frogbot-configuration.md #148

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
10 changes: 5 additions & 5 deletions jfrog-applications/frogbot/frogbot-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ The **frogbot-config.yml** file encompasses project-related configurations used

### Is the frogbot-config.yml file mandatory?

No, the file isn't mandatory. In most cases, Frogbot can understand the structure of the projects in the repository and list the project's depedencies without the file.
No, the file isn't mandatory. In most cases, Frogbot can understand the structure of the projects in the repository and list the project's dependencies without the file.

If your project doesn't use a **frogbot-config.yml** file, all the configuration Frogbot requires\
should be provided as variables as part of the Frogbot workflows.

### How does the frogbot-config.yml file helps Frogbot scan the repository?
### How does the frogbot-config.yml file help Frogbot scan the repository?

Frogbot relies on the project's descriptor files, such as package.json and pom.xml, to identify the project's dependencies. It scans the repository for these descriptor files and utilizes the appropriate package manager, such as npm or Maven, to compile a list of dependencies for the project. If you desire manual control over the project structure or the package manager commands, you can achieve this by creating a **frogbot-config.yml** file. In the provided example, we outline two subprojects located at **path/to/project-1** and **path/to/project-2** for Frogbot to include in its scanning process.

Expand Down Expand Up @@ -49,7 +49,7 @@ Here's another example. Notice that we specify a custom `install` command here.

### Can one frogbot-config.yml file be used for multiple Git repositories?

You have the option of using a single **frogbot-config.yml** file for scanning multiple Git repositories in the same organization if one of the following platforms is used.
You have the option of using a single **frogbot-config.yml** file to scan multiple Git repositories in the same organization if one of the following platforms is used.

* GitHub with Jenkins or JFrog Pipelines
* Bitbucket Server
Expand Down Expand Up @@ -79,7 +79,7 @@ The file can be placed in any repository if it's in the same organization as all
- pipRequirementsFile: requirements.txt
```

If however you're using one of the following platforms, each repository that needs to be scanned by Frogbot should include its own **frogbot-config.yml** file.
If, however, you're using one of the following platforms, each repository that needs to be scanned by Frogbot should include its own **frogbot-config.yml** file.

* GitHub with GitHub actions
* GitLab
Expand All @@ -88,7 +88,7 @@ If however you're using one of the following platforms, each repository that nee

Frogbot expects the frogbot-config.yml file to be in the following path from the root of the Git repository: `.frogbot/frogbot-config.yml`.

**IMPORTANT**: The `frogbot-config.yml` file must be pushed to the target branch before it can be used by Frogbot. This means that if, for example, a pull request includes the `frogbot-config.yml` and the target branch doesn't, the file will be ignored.
**IMPORTANT**: The `frogbot-config.yml` file must be pushed to the target branch before Frogbot can use it. This means that if, for example, a pull request includes the `frogbot-config.yml` and the target branch doesn't, the file will be ignored.

### The frogbot-config.yml file structure

Expand Down
Loading