Skip to content

Commit 71fc51f

Browse files
committed
chore: cleanup some old links
1 parent ca87ce5 commit 71fc51f

File tree

3 files changed

+7
-10
lines changed

3 files changed

+7
-10
lines changed

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,29 +36,26 @@ sheriff patrol --url gitlab://your-namespace-or-group --report-to-issue
3636
Sheriff analyzes repositories in source code repository hosting services (such as GitLab) looking for vulnerabilities
3737
in the dependencies of the scanned repositories. Sheriff uses one or several third-party scanners to detect these vulnerabilities, and aggregates them into its reports. See a list of supported platforms and scanners in the [section below](#supported-platforms).
3838

39-
Sheriff is best used for analyzing vulnerabilities in bulk, regularly scanning groups of repositories to provide an overview of which vulnerabilities affect them. For that, Sheriff provides different types of reports, and it can publish them to different platforms: gitlab, ?.
39+
Sheriff is best used for analyzing vulnerabilities in bulk, regularly scanning groups of repositories to provide an overview of which vulnerabilities affect them. For that, Sheriff provides different types of reports, and it can publish them to different platforms such as GitLab (see [supported platforms section](#supported-platforms)).
4040

4141
### Issue in the affected repository
4242

4343
Sheriff will keep an open issue in each one of the analyzed repositories, providing a detailed report of which vulnerabilities have been found by its scanners.
4444

4545
<img width="600" alt='issue-report' src='./assets/issue-report.png'>
4646

47-
4847
### Report message
4948

5049
Sheriff will post a message to a messaging service with an overview of the analyzed repositories and the vulerabilities detected. This message is intended to provide a generic overview to those in charge of security to oversee the state of a given group of repositories.
5150

5251
<img width='400' alt='msg-report' src='assets/report-msg.png'>
5352

54-
5553
### Specific repository message
5654

5755
Project teams can also be informed regularly by Sheriff (if they want to) by configuring a channel to which Sheriff should report its findings of a given repository. The message generated by Sheriff will be slightly different, and will contain only information relevant for the repository maintainers.
5856

5957
<img width='400' alt='repo-report' src='assets/report-repo.png'>
6058

61-
6259
## Installation
6360

6461
### Docker
@@ -115,13 +112,13 @@ report-to-gitlab-issue = true
115112
And if you wish to specify a different file, you can do so with `sheriff patrol --config your-config-file.toml`.
116113

117114
> [!NOTE]
118-
> When using several type of configuration at once there is an order of preference: **cli flags** > **env vars** > **config file**
115+
> When using several types of configurations at once there is an order of preference: **cli flags** > **env vars** > **config file**
119116
120117
## Supported platforms
121118

122119
### Source code hosting services
123120

124-
- [x] [GitLab](https://gitlab.com/dashboard/merge_requests?assignee_username=sergio.lara1)
121+
- [x] [GitLab](https://gitlab.com)
125122
- [ ] [GitHub](https://github.com) ([#9](https://github.com/elementsinteractive/sheriff/issues/9))
126123

127124
### Messaging services
@@ -156,4 +153,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
156153

157154
<!-- ALL-CONTRIBUTORS-LIST:END -->
158155

159-
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
156+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

internal/publish/to_gitlab.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,9 +146,9 @@ func getVulnReportHeader() string {
146146
currentTime := now().Local()
147147

148148
return fmt.Sprintf(`
149-
ℹ️ This issue lists all the vulnerabilities found in the project by [Sheriff](https://gitlab.com/namespace/sheriff) on %s.
149+
ℹ️ This issue lists all the vulnerabilities found in the project by [Sheriff](https://github.com/elementsinteractive/sheriff) on %s.
150150
151-
Please review the vulnerabilities and take the necessary actions to fix or acknowledge them, see the [sheriff documentation](https://security-scanner-c26e93.gitlab.io/user-guide/) for more information.`,
151+
Please review the vulnerabilities and take the necessary actions to fix or acknowledge them, see the [sheriff documentation](https://github.com/elementsinteractive/sheriff) for more information.`,
152152
currentTime.Format("2006-01-02"),
153153
)
154154
}

internal/publish/to_gitlab_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ func TestGitlabIssueReportHeader(t *testing.T) {
196196

197197
got := getVulnReportHeader()
198198

199-
want := `ℹ️ This issue lists all the vulnerabilities found in the project by [Sheriff](https://gitlab.com/namespace/sheriff) on 2021-01-01.`
199+
want := `ℹ️ This issue lists all the vulnerabilities found in the project by [Sheriff](https://github.com/elementsinteractive/sheriff) on 2021-01-01.`
200200

201201
assert.Contains(t, got, want)
202202

0 commit comments

Comments
 (0)