Skip to content

Commit 53d9af9

Browse files
jbeveland27jbeveland27
authored
Merge pull request newrelic#35 from newrelic/chore/forum
2 parents ad54ca2 + 8f2bba8 commit 53d9af9

File tree

4 files changed

+43
-43
lines changed

4 files changed

+43
-43
lines changed

‎docs/repolinter/policy-overviews.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The following is a high-level overview of the rulesets being enforced by [repoli
1212
```
1313
* `readme-contains-security-section` - Checks that a `## Security` markdown header exists in `README.md`. This check is designed to determine if a security section is present.
1414
* `readme-contains-link-to-security-policy` - Checks that a link to the security policy is present in `README.md`. The security policy can be found under `https://github.com/newrelic/<repo-name>/security/policy` or `../../security/policy`.
15-
* `readme-contains-discuss-topic` - Checks that a valid link to `discuss.newrelic.com` exists in `README.md`.
15+
* `readme-contains-forum-topic` - Checks that a valid link to `forum.newrelic.com` exists in `README.md`.
1616
* `code-of-conduct-should-not-exist-here` - Checks that a code of conduct file is not present in the repository. This file can match any of the following patterns:
1717
* `CODE-OF-CONDUCT*`
1818
* `CODE_OF_CONDUCT*`
@@ -45,7 +45,7 @@ reStructured Text:
4545
:target: https://opensource.newrelic.com/oss-category/#community-plus
4646
```
4747
* `readme-contains-link-to-security-policy` - Checks that a link to the security policy is present in `README.md`. The security policy can be found under `https://github.com/newrelic/<repo-name>/security/policy` or `../../security/policy`.
48-
* `readme-contains-discuss-topic` - Checks that a valid link to `discuss.newrelic.com` exists in `README.md`.
48+
* `readme-contains-forum-topic` - Checks that a valid link to `forum.newrelic.com` exists in `README.md`.
4949
* `code-of-conduct-should-not-exist-here` - Checks that a code of conduct file is not present in the repository. This file can match any of the following patterns:
5050
* `CODE-OF-CONDUCT*`
5151
* `CODE_OF_CONDUCT*`
@@ -113,4 +113,4 @@ reStructured Text:
113113
## Notes for Ruleset Creation
114114
* If the rule intends to check the contents of `README.md`, ensure that a [`README.rst`](https://github.com/DevDungeon/reStructuredText-Documentation-Reference) is also supported, as some projects prefer reStructured text to Markdown (ex. [newrelic-python-agent](https://github.com/newrelic/newrelic-python-agent)).
115115
* Make sure to double check all the links!
116-
* Remember to add the ruleset path to the [`test` workflow](./.github/workflows/test.yml).
116+
* Remember to add the ruleset path to the [`test` workflow](./.github/workflows/test.yml).

‎repolinter-rulesets/community-plus.yml

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ rules:
88
type: file-existence
99
options:
1010
globsAny:
11-
- LICENSE*
12-
- COPYING*
11+
- LICENSE*
12+
- COPYING*
1313
nocase: true
1414
fix:
1515
type: file-create
@@ -29,7 +29,7 @@ rules:
2929
type: file-existence
3030
options:
3131
globsAny:
32-
- README*
32+
- README*
3333
nocase: true
3434
fix:
3535
type: file-create
@@ -48,12 +48,12 @@ rules:
4848
type: file-starts-with
4949
options:
5050
globsAll:
51-
- README*
51+
- README*
5252
nocase: true
5353
lineCount: 5
5454
patterns:
55-
- '<a href="https:\/\/opensource\.newrelic\.com\/oss-category\/#community-plus"><picture><source media="\(prefers-color-scheme: dark\)" srcset="https:\/\/github\.com\/newrelic\/opensource-website\/raw\/main\/src\/images\/categories\/dark\/Community_Plus\.png"><source media="\(prefers-color-scheme: light\)" srcset="https:\/\/github\.com\/newrelic\/opensource-website\/raw\/main\/src\/images\/categories\/Community_Plus\.png"><img alt="New Relic Open Source community plus project banner\." src="https:\/\/github\.com\/newrelic\/opensource-website\/raw\/main\/src\/images\/categories\/Community_Plus\.png"><\/picture><\/a>'
56-
- https:\/\/opensource\.newrelic\.com\/oss-category\/#community-plus
55+
- '<a href="https:\/\/opensource\.newrelic\.com\/oss-category\/#community-plus"><picture><source media="\(prefers-color-scheme: dark\)" srcset="https:\/\/github\.com\/newrelic\/opensource-website\/raw\/main\/src\/images\/categories\/dark\/Community_Plus\.png"><source media="\(prefers-color-scheme: light\)" srcset="https:\/\/github\.com\/newrelic\/opensource-website\/raw\/main\/src\/images\/categories\/Community_Plus\.png"><img alt="New Relic Open Source community plus project banner\." src="https:\/\/github\.com\/newrelic\/opensource-website\/raw\/main\/src\/images\/categories\/Community_Plus\.png"><\/picture><\/a>'
56+
- https:\/\/opensource\.newrelic\.com\/oss-category\/#community-plus
5757
human-readable-pattern: Open source Community Plus header (see https://opensource.newrelic.com/oss-category)
5858
flags: i
5959
succeed-on-non-existent: false
@@ -76,7 +76,7 @@ rules:
7676
type: file-contents
7777
options:
7878
globsAll:
79-
- README*
79+
- README*
8080
fail-on-non-existent: true
8181
flags: i
8282
content: (?:(?:https:\/\/github\.com\/newrelic\/[^\/]+)|(?:\.\.\/\.\.))\/security\/policy
@@ -87,19 +87,19 @@ rules:
8787
in the README. For an example of this, please see the "a note about vulnerabilities"
8888
section of the [Open By Default repository](https://github.com/newrelic/open-by-default#contribute)
8989
policyUrl: https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code
90-
readme-contains-discuss-topic:
90+
readme-contains-forum-topic:
9191
level: error
9292
rule:
9393
type: file-contents
9494
options:
9595
globsAll:
96-
- README*
96+
- README*
9797
fail-on-non-existent: true
9898
flags: i
99-
content: discuss\.newrelic\.com
100-
human-readable-content: a link to the appropriate discuss.newrelic.com topic
99+
content: forum\.newrelic\.com
100+
human-readable-content: a link to the appropriate forum.newrelic.com topic
101101
policyInfo: >-
102-
New Relic recommends directly linking the your appropriate discuss.newrelic.com
102+
New Relic recommends directly linking the your appropriate forum.newrelic.com
103103
topic in the README, allowing developer an alternate method of getting support
104104
policyUrl: https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code
105105
code-of-conduct-should-not-exist-here:
@@ -108,9 +108,9 @@ rules:
108108
type: file-not-exists
109109
options:
110110
globsAll:
111-
- CODE_OF_CONDUCT*
112-
- CODE-OF-CONDUCT*
113-
- CODEOFCODUCT
111+
- CODE_OF_CONDUCT*
112+
- CODE-OF-CONDUCT*
113+
- CODEOFCODUCT
114114
nocase: true
115115
fix:
116116
type: file-remove
@@ -127,9 +127,9 @@ rules:
127127
type: file-existence
128128
options:
129129
globsAny:
130-
- THIRD_PARTY_NOTICES*
131-
- THIRD-PARTY-NOTICES*
132-
- THIRDPARTYNOTICES*
130+
- THIRD_PARTY_NOTICES*
131+
- THIRD-PARTY-NOTICES*
132+
- THIRDPARTYNOTICES*
133133
nocase: true
134134
policyInfo: >-
135135
A [`THIRD_PARTY_NOTICES.md`](https://github.com/newrelic/opensource-website/blob/develop/THIRD_PARTY_NOTICES.md)

‎repolinter-rulesets/community-project.yml

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ rules:
88
type: file-existence
99
options:
1010
globsAny:
11-
- LICENSE*
12-
- COPYING*
11+
- LICENSE*
12+
- COPYING*
1313
nocase: true
1414
fix:
1515
type: file-create
@@ -29,7 +29,7 @@ rules:
2929
type: file-existence
3030
options:
3131
globsAny:
32-
- README*
32+
- README*
3333
nocase: true
3434
fix:
3535
type: file-create
@@ -48,12 +48,12 @@ rules:
4848
type: file-starts-with
4949
options:
5050
globsAll:
51-
- README*
51+
- README*
5252
nocase: true
5353
lineCount: 5
5454
patterns:
55-
- '<a href="https:\/\/opensource\.newrelic\.com\/oss-category\/#community-project"><picture><source media="\(prefers-color-scheme: dark\)" srcset="https:\/\/github\.com\/newrelic\/opensource-website\/raw\/main\/src\/images\/categories\/dark\/Community_Project\.png"><source media="\(prefers-color-scheme: light\)" srcset="https:\/\/github\.com\/newrelic\/opensource-website\/raw\/main\/src\/images\/categories\/Community_Project\.png"><img alt="New Relic Open Source community project banner\." src="https:\/\/github\.com\/newrelic\/opensource-website\/raw\/main\/src\/images\/categories\/Community_Project\.png"><\/picture><\/a>'
56-
- https:\/\/opensource\.newrelic\.com\/oss-category\/#community-project
55+
- '<a href="https:\/\/opensource\.newrelic\.com\/oss-category\/#community-project"><picture><source media="\(prefers-color-scheme: dark\)" srcset="https:\/\/github\.com\/newrelic\/opensource-website\/raw\/main\/src\/images\/categories\/dark\/Community_Project\.png"><source media="\(prefers-color-scheme: light\)" srcset="https:\/\/github\.com\/newrelic\/opensource-website\/raw\/main\/src\/images\/categories\/Community_Project\.png"><img alt="New Relic Open Source community project banner\." src="https:\/\/github\.com\/newrelic\/opensource-website\/raw\/main\/src\/images\/categories\/Community_Project\.png"><\/picture><\/a>'
56+
- https:\/\/opensource\.newrelic\.com\/oss-category\/#community-project
5757
human-readable-pattern: Open source Community header (see https://opensource.newrelic.com/oss-category)
5858
flags: i
5959
succeed-on-non-existent: false
@@ -76,7 +76,7 @@ rules:
7676
type: file-contents
7777
options:
7878
globsAll:
79-
- README*
79+
- README*
8080
fail-on-non-existent: true
8181
flags: i
8282
content: (?:(?:https:\/\/github\.com\/newrelic\/[^\/]+)|(?:\.\.\/\.\.))\/security\/policy
@@ -87,19 +87,19 @@ rules:
8787
in the README. For an example of this, please see the "a note about vulnerabilities"
8888
section of the [Open By Default repository](https://github.com/newrelic/open-by-default#contribute)
8989
policyUrl: https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code
90-
readme-contains-discuss-topic:
90+
readme-contains-forum-topic:
9191
level: error
9292
rule:
9393
type: file-contents
9494
options:
9595
globsAll:
96-
- README*
96+
- README*
9797
fail-on-non-existent: true
9898
flags: i
99-
content: discuss\.newrelic\.com
100-
human-readable-content: a link to the appropriate discuss.newrelic.com topic
99+
content: forum\.newrelic\.com
100+
human-readable-content: a link to the appropriate forum.newrelic.com topic
101101
policyInfo: >-
102-
New Relic recommends directly linking the your appropriate discuss.newrelic.com
102+
New Relic recommends directly linking the your appropriate forum.newrelic.com
103103
topic in the README, allowing developer an alternate method of getting support
104104
policyUrl: https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code
105105
code-of-conduct-should-not-exist-here:
@@ -108,9 +108,9 @@ rules:
108108
type: file-not-exists
109109
options:
110110
globsAll:
111-
- CODE_OF_CONDUCT*
112-
- CODE-OF-CONDUCT*
113-
- CODEOFCODUCT
111+
- CODE_OF_CONDUCT*
112+
- CODE-OF-CONDUCT*
113+
- CODEOFCODUCT
114114
nocase: true
115115
fix:
116116
type: file-remove
@@ -127,9 +127,9 @@ rules:
127127
type: file-existence
128128
options:
129129
globsAny:
130-
- THIRD_PARTY_NOTICES*
131-
- THIRD-PARTY-NOTICES*
132-
- THIRDPARTYNOTICES*
130+
- THIRD_PARTY_NOTICES*
131+
- THIRD-PARTY-NOTICES*
132+
- THIRDPARTYNOTICES*
133133
nocase: true
134134
policyInfo: >-
135135
A [`THIRD_PARTY_NOTICES.md`](https://github.com/newrelic/opensource-website/blob/develop/THIRD_PARTY_NOTICES.md)

‎repolinter-rulesets/new-relic-one-catalog-project.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,19 +97,19 @@
9797
"policyInfo": "New Relic recommends referencing the open source security policy (`https://github.com/newrelic/<repo-name>/security/policy` or `../../security/policy`) in a Security section in the README. For an example of this, please see the [NR1 Catalog Template](https://github.com/newrelic/template-nerdpack#security)",
9898
"policyUrl": "https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code"
9999
},
100-
"readme-contains-discuss-topic": {
100+
"readme-contains-forum-topic": {
101101
"level": "error",
102102
"rule": {
103103
"type": "file-contents",
104104
"options": {
105105
"globsAll": ["README*"],
106106
"fail-on-non-existent": true,
107107
"flags": "i",
108-
"content": "discuss\\.newrelic\\.com",
109-
"human-readable-content": "a link to the appropriate discuss.newrelic.com topic"
108+
"content": "forum\\.newrelic\\.com",
109+
"human-readable-content": "a link to the appropriate forum.newrelic.com topic"
110110
}
111111
},
112-
"policyInfo": "New Relic recommends directly linking the your appropriate discuss.newrelic.com topic in the README, allowing developer an alternate method of getting support",
112+
"policyInfo": "New Relic recommends directly linking the your appropriate forum.newrelic.com topic in the README, allowing developer an alternate method of getting support",
113113
"policyUrl": "https://nerdlife.datanerd.us/new-relic/security-guidelines-for-publishing-source-code"
114114
},
115115
"third-party-notices-file-exists": {

0 commit comments

Comments
 (0)