From 5d26410cbf1d806940fce001780ad53e60e00e04 Mon Sep 17 00:00:00 2001 From: vladislav doster <10052309+vladdoster@users.noreply.github.com> Date: Sun, 18 Aug 2024 15:46:17 -0500 Subject: [PATCH] Update frogbot-configuration.md - Correct spelling and punctuation mistakes - Rephrase text to make it easier to read --- jfrog-applications/frogbot/frogbot-configuration.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/jfrog-applications/frogbot/frogbot-configuration.md b/jfrog-applications/frogbot/frogbot-configuration.md index 5c0bf7b..38574e1 100644 --- a/jfrog-applications/frogbot/frogbot-configuration.md +++ b/jfrog-applications/frogbot/frogbot-configuration.md @@ -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. @@ -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 @@ -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 @@ -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