Skip to content

Commit

Permalink
Merge branch '404' into 'main'
Browse files Browse the repository at this point in the history
fixed links to changelog

See merge request CodeScoring/docs!232
  • Loading branch information
amaksimovv committed Aug 30, 2024
2 parents e426288 + 01caf72 commit 80caa34
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/agent/gitlab-ci.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The CLI agent supports integration into Gitlab CI using the `.gitlab-ci.yaml` fi

An example of the contents of the `.gitlab-ci.yaml` file when using a Docker image of the agent:

`<version>` must be replaced with the agent version. A list of current versions with descriptions is available [here](/changelog.en/#johnny).
`<version>` must be replaced with the agent version. A list of current versions with descriptions is available in [Changelog](/changelog/johnny-changelog.en/).

```yaml
stages:
Expand Down Expand Up @@ -51,7 +51,7 @@ To use the agent binary file, you must first perform the following steps on the
```bash
curl -o /usr/local/bin/johnny https://REGISTRY_USERNAME:[email protected]/repository/files/codescoring/johnny-depp/JOHNNY_VERSION/johnny-linux-amd64-JOHNNY_VERSION
```
`JOHNNY_VERSION` must be replaced with the agent version. A list of current versions with descriptions is available [here](/changelog.en/#johnny). `REGISTRY_USERNAME` and `REGISTRY_PASSWORD` must be replaced with the login and password received from the vendor.
`JOHNNY_VERSION` must be replaced with the agent version. A list of current versions with descriptions is available in [Changelog](/changelog/johnny-changelog.en/). `REGISTRY_USERNAME` and `REGISTRY_PASSWORD` must be replaced with the login and password received from the vendor.
2. Allow file execution
```bash
chmod +x /usr/local/bin/johnny
Expand Down
4 changes: 2 additions & 2 deletions docs/agent/gitlab-ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ hide:

Пример содержания файла `.gitlab-ci.yaml` при использовании docker-образа консольного агента:

`<version>` необходимо заменить на версию агента. Список актуальных версий с описанием доступен [здесь](/changelog/#johnny).
`<version>` необходимо заменить на версию агента. Список актуальных версий с описанием доступен на странице [Changelog](/changelog/johnny-changelog/).

```yaml
stages:
Expand Down Expand Up @@ -51,7 +51,7 @@ sca:
```bash
curl -o /usr/local/bin/johnny https://REGISTRY_USERNAME:[email protected]/repository/files/codescoring/johnny-depp/JOHNNY_VERSION/johnny-linux-amd64-JOHNNY_VERSION
```
`JOHNNY_VERSION` необходимо заменить на версию агента. Список актуальных версий с описанием доступен [здесь](/changelog/#johnny). `REGISTRY_USERNAME` и `REGISTRY_PASSWORD` необходимо заменить на логин и пароль, полученные от вендора.
`JOHNNY_VERSION` необходимо заменить на версию агента. Список актуальных версий с описанием доступен на странице [Changelog](/changelog/johnny-changelog/). `REGISTRY_USERNAME` и `REGISTRY_PASSWORD` необходимо заменить на логин и пароль, полученные от вендора.
2. Разрешить исполнение файла
```bash
chmod +x /usr/local/bin/johnny
Expand Down
2 changes: 1 addition & 1 deletion docs/on-premise/installation.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Usually no changes are required for correct operation. If you need to configure
- Exception paths
- `ANALYSIS_IGNORED_PATHS` - list of paths that will be ignored by the system during analysis. More details on adding exclusion paths can be found [here](/on-premise/analysis-ignore-paths/)
- System version
- `CODESCORING_VERSION` is a required variable. The current version can be found in the [Changelog](/changelog) section
- `CODESCORING_VERSION` is a required variable. The current version can be found in the [Changelog](/changelog/on-premise-changelog.en) section

**Note**: do not use the `#` symbol in the parameters, it may be interpreted incorrectly by the system during installation.

Expand Down
2 changes: 1 addition & 1 deletion docs/on-premise/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ hide:
- Пути исключений
- `ANALYSIS_IGNORED_PATHS` - список путей, которые будут игнорироваться системой при анализе. Подробнее с добавлением путей исключения можно ознакомиться [тут](/on-premise/analysis-ignore-paths/)
- Версия системы
- `CODESCORING_VERSION` – обязательная переменная. Актуальную версию можно узнать в разделе [Changelog](/changelog)
- `CODESCORING_VERSION` – обязательная переменная. Актуальную версию можно узнать в разделе [Changelog](/changelog/on-premise-changelog)

**Примечание**: не используйте в параметрах символ `#`, он может некорректно восприниматься системой при установке.

Expand Down

0 comments on commit 80caa34

Please sign in to comment.