Skip to content

Commit bbe701a

Browse files
Rewrite readme and fix workflows (#3433)
* Update bug report template * Update uBO bug report template * Update config * Update security report template * Update delete workflow runs * Update on-issue-comment.yml * Rewrite readme * My bad * a quick fix * fix
1 parent 359914d commit bbe701a

File tree

6 files changed

+66
-53
lines changed

6 files changed

+66
-53
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,22 @@ body:
44
- type: markdown
55
attributes:
66
value: |
7-
Speculated performance issues will be marked as invalid and closed if they do not come with actual profiling data from the [Firefox Profiler](https://profiler.firefox.com/)/[Chromium Profiler](https://developer.chrome.com/docs/devtools/evaluate-performance/reference/) and a fully substantiated analysis supporting the claim.
7+
Speculated performance issues will be marked as invalid and closed if they do not come with actual profiling data from the [Firefox Profiler](https://profiler.firefox.com/)/[Chromium Profiler](https://developer.chrome.com/docs/devtools/performance/reference) and a fully substantiated analysis supporting the claim.
88
New filter list requests are not permitted and will be declined and closed.
9+
910
- type: checkboxes
1011
attributes:
1112
label: Prerequisites
1213
description: |
1314
To rule out invalid issues, confirm and check each one of the checkboxes.
14-
If you are unable to determine whether it's a filter list issue, do not open an issue here, first seek help on support forums.
15+
If you are unable to determine whether it's a filter list issue, do not open an issue here; first seek help on support forums.
1516
If [disabling uBO](https://github.com/gorhill/uBlock/wiki/Quick-guide:-popup-user-interface#the-large-power-button) makes the issue go away, then it is a filter issue.
16-
See what [the logger](https://github.com/gorhill/uBlock/wiki/The-logger) reports when you reproduce the issue, this will help you determine whether this is a filter issue.
17+
See what [the logger](https://github.com/gorhill/uBlock/wiki/The-logger) reports when you reproduce the issue; this will help you determine whether this is a filter issue.
1718
If the issue is still present after disabling uBlock Origin (uBO) in the browser, it is unrelated to uBO.
1819
options:
1920
- label: I verified that this is not a filter list issue. Report any issues with filter lists or broken website functionality in the [uAssets issue tracker](https://github.com/uBlockOrigin/uAssets/issues).
2021
required: true
21-
- label: This is **NOT** a [_YouTube_](https://www.github.com/uBlockOrigin/uAssets/issues/20586), [_Facebook_](https://www.github.com/uBlockOrigin/uAssets/issues/3367) or [_Twitch_](https://www.github.com/uBlockOrigin/uAssets/issues/5184) report. _These sites MUST be reported by clicking their **respective links**_.
22+
- label: This is **NOT** a [_YouTube_](https://github.com/uBlockOrigin/uAssets/issues/20586), [_Facebook_](https://github.com/uBlockOrigin/uAssets/issues/3367) or [_Twitch_](https://github.com/uBlockOrigin/uAssets/issues/5184) report. _These sites MUST be reported by clicking their **respective links**_.
2223
required: true
2324
- label: This is not a support issue or a question. For support, questions, or help, visit [/r/uBlockOrigin](https://www.reddit.com/r/uBlockOrigin/).
2425
required: true
@@ -94,6 +95,6 @@ body:
9495

9596
- type: input
9697
attributes:
97-
label: Operating System and version
98+
label: Operating system and version
9899
validations:
99100
required: true

.github/ISSUE_TEMPLATE/bug_report_from_ubo.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,21 @@ body:
44
- type: markdown
55
attributes:
66
value: |
7-
Speculated performance issues will be marked as invalid and closed if they do not come with actual profiling data from the [Firefox Profiler](https://profiler.firefox.com/)/[Chromium Profiler](https://developer.chrome.com/docs/devtools/evaluate-performance/reference/) and a fully substantiated analysis supporting the claim.
7+
Speculated performance issues will be marked as invalid and closed if they do not come with actual profiling data from the [Firefox Profiler](https://profiler.firefox.com/)/[Chromium Profiler](https://developer.chrome.com/docs/devtools/performance/reference) and a fully substantiated analysis supporting the claim.
88
New filter list requests are not permitted and will be declined and closed.
9+
910
- type: checkboxes
1011
attributes:
1112
label: Prerequisites
1213
description: |
1314
To rule out invalid issues, confirm and check each one of the checkboxes.
1415
If [disabling uBO](https://github.com/gorhill/uBlock/wiki/Quick-guide:-popup-user-interface#the-large-power-button) makes the issue go away, then it is a filter issue.
15-
See what [the logger](https://github.com/gorhill/uBlock/wiki/The-logger) reports when you reproduce the issue, this will help you determine whether this is a filter issue.
16+
See what [the logger](https://github.com/gorhill/uBlock/wiki/The-logger) reports when you reproduce the issue; this will help you determine whether this is a filter issue.
1617
If the issue is still present after disabling uBlock Origin (uBO) in the browser, it is unrelated to uBO.
1718
options:
1819
- label: I verified that this is not a filter list issue. Report any issues with filter lists or broken website functionality in the [uAssets issue tracker](https://github.com/uBlockOrigin/uAssets/issues).
1920
required: true
20-
- label: This is **NOT** a [_YouTube_](https://www.github.com/uBlockOrigin/uAssets/issues/20586), [_Facebook_](https://www.github.com/uBlockOrigin/uAssets/issues/3367) or [_Twitch_](https://www.github.com/uBlockOrigin/uAssets/issues/5184) report. _These sites MUST be reported by clicking their **respective links**_.
21+
- label: This is **NOT** a [_YouTube_](https://github.com/uBlockOrigin/uAssets/issues/20586), [_Facebook_](https://github.com/uBlockOrigin/uAssets/issues/3367) or [_Twitch_](https://github.com/uBlockOrigin/uAssets/issues/5184) report. _These sites MUST be reported by clicking their **respective links**_.
2122
required: true
2223
- label: I performed a [cursory search of the issue tracker](https://github.com/uBlockOrigin/uBlock-issues/issues?q=is%3Aissue) to avoid opening a duplicate issue.
2324
required: true
@@ -32,7 +33,7 @@ body:
3233
options:
3334
- label: uBO is the only extension.
3435
required: true
35-
- label: using a new, unmodified browser profile.
36+
- label: Using a new, unmodified browser profile.
3637
required: true
3738

3839
- type: textarea

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ contact_links:
77
url: https://github.com/uBlockOrigin/uAssets/issues
88
about: Report issues with filter lists or broken website functionality in the uAssets issue tracker.
99
- name: uBO Lite (uBOL) Issues
10-
url: https://github.com/uBlockOrigin/uBOL-issues/issues
10+
url: https://github.com/uBlockOrigin/uBOL-home/issues
1111
about: Report issues specific to the Manifest Version 3 (MV3) variant in the uBOL issue tracker.
12-
- name: Filter List Requests
13-
url: https://github.com/uBlockOrigin/uBlock-issues#filter-list-requests
12+
- name: Filter List Issues
13+
url: https://github.com/uBlockOrigin/uBlock-issues#filter-list-issues
1414
about: New filter list requests are not permitted and will be declined and closed.
Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
1-
name: del-runs-comments
2-
on: workflow_dispatch
1+
name: Delete workflow runs
2+
3+
on:
4+
workflow_dispatch:
5+
36
jobs:
47
runx:
58
runs-on: ubuntu-latest
69
permissions: write-all
10+
711
steps:
8-
- uses: christosgalano/[email protected]
12+
- name: Delete workflow runs
13+
uses: christosgalano/delete-gh-workflow-runs@v1
914
with:
1015
owner: uBlockOrigin
1116
repo: uBlock-issues
1217
token: ${{ secrets.GITHUB_TOKEN }}
1318
workflow: on-issue-comment
14-
15-
16-
17-
18-
19-
Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,39 @@
1-
name: on-issue-comment
1+
name: Delete Bad Comments
2+
23
on:
4+
workflow_dispatch:
35
issue_comment:
46
types: created
7+
58
jobs:
69
check-if-bad-comment:
7-
name: delete bad comment
10+
name: Delete Bad Comment
811
runs-on: ubuntu-latest
9-
if: (( contains(github.event.comment.body, 'Download') || contains(github.event.comment.body, 'install') || contains(github.event.comment.body, 'mediafire') || contains(github.event.comment.body, 'changeme') ) && ( contains(github.event.comment.body, 'gcc') || contains(github.event.comment.body, 'usx'))) || ( contains(github.event.comment.body, 'install') && ( contains(github.event.comment.body, 'mediafire') || contains(github.event.comment.body, 'gofile') ))
12+
if: >-
13+
(
14+
(contains(github.event.comment.body, 'Download') ||
15+
contains(github.event.comment.body, 'install') ||
16+
contains(github.event.comment.body, 'mediafire') ||
17+
contains(github.event.comment.body, 'changeme')) &&
18+
(contains(github.event.comment.body, 'gcc') ||
19+
contains(github.event.comment.body, 'usx'))
20+
) ||
21+
(
22+
contains(github.event.comment.body, 'install') &&
23+
(contains(github.event.comment.body, 'mediafire') ||
24+
contains(github.event.comment.body, 'gofile'))
25+
)
26+
1027
permissions: write-all
28+
1129
steps:
12-
- name: Delete comment
30+
- name: Echo event comment body
1331
run: |
14-
echo " ${{ github.event.comment.body }} "
15-
- uses: actions-cool/issues-helper@v3
32+
echo "${{ github.event.comment.body }}"
33+
34+
- name: Delete comments
35+
uses: actions-cool/issues-helper@v3
1636
with:
1737
actions: 'delete-comment'
1838
token: ${{ secrets.GITHUB_TOKEN }}
19-
comment-id: ${{ github.event.comment.id }}
39+
comment-id: ${{ github.event.comment.id }}

README.md

Lines changed: 17 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,31 @@
11
# uBlock Origin (uBO) Issues
22

3-
This repository is the official community-maintained issue tracker for [uBO](https://github.com/gorhill/uBlock).
4-
5-
#### Support Forum
3+
Welcome to the official community-maintained issue tracker for [uBlock Origin (uBO)](https://github.com/gorhill/uBlock).
64

5+
## Support Forum
76
For support, questions, or help, visit [/r/uBlockOrigin](https://www.reddit.com/r/uBlockOrigin/).
87

9-
#### Filter List Issues
10-
11-
Report issues with filter lists or broken website functionality in the [uAssets issue tracker](https://github.com/uBlockOrigin/uAssets/issues).
12-
13-
#### uBO Lite (uBOL) Issues
14-
15-
Report issues specific to the Manifest Version 3 (MV3) variant in the [uBOL issue tracker](https://github.com/uBlockOrigin/uBOL-issues/issues).
16-
17-
#### Performance Issues
8+
## Filter List Issues
9+
If you encounter issues with filter lists or broken website functionality, please report them in the [uAssets issue tracker](https://github.com/uBlockOrigin/uAssets/issues).
1810

19-
Speculated performance issues are marked as invalid and closed if they do not come with actual profiling data from the [Firefox Profiler](https://profiler.firefox.com/)/[Chromium Profiler](https://developer.chrome.com/docs/devtools/performance/reference/) and a fully substantiated analysis supporting the claim.
11+
## uBO Lite (uBOL) Issues
12+
For issues specific to the Manifest Version 3 (MV3) variant, use the [uBOL issue tracker](https://github.com/uBlockOrigin/uBOL-home/issues).
2013

21-
#### WebRTC Issues
14+
## Performance Issues
15+
Performance issues without actual profiling data from the [Firefox Profiler](https://profiler.firefox.com/) or [Chromium Profiler](https://developer.chrome.com/docs/devtools/performance/reference/) will be marked as invalid and closed. Please provide a fully substantiated analysis to support your claims.
2216

23-
Do not open issues about WebRTC leaking local IP addresses. Supported modern browsers do not cause undue local IP address leaks through WebRTC. uBO is not a VPN/proxy tool. If you are experiencing such an issue, report it to the browser or VPN/proxy tools software provider or, if needed, both.
24-
25-
#### Filter List Requests
17+
## WebRTC Issues
18+
Do not open issues regarding WebRTC leaking local IP addresses. Supported modern browsers do not leak local IPs through WebRTC. uBO is not a VPN/proxy tool. If you experience such issues, report them to your browser or VPN/proxy software provider.
2619

20+
## Filter List Requests
2721
New filter list requests are not permitted and will be declined and closed.
2822

29-
# uBO Development Builds
30-
31-
Use the development builds to help report issues and regressions before the next stable release.
23+
---
3224

33-
Once you install a development build, it will automatically update when a new version is published.
34-
35-
- **Chromium**: Install from the [Chrome Web Store](https://chrome.google.com/webstore/detail/ublock-origin-development/cgbcahbpdhpcegmbfconppldiemgcoii).
25+
# uBO Development Builds
3626

37-
- **Firefox**: Click the most recent `uBlock0_[version].firefox.signed.xpi` file from the [uBO Releases page](https://github.com/gorhill/uBlock/releases).
27+
Use the development builds to report issues and regressions before the next stable release. Once installed, development builds will automatically update to the latest version.
3828

39-
- **Thunderbird**: Download the most recent `uBlock0_[version].thunderbird.xpi` file from the [uBO Releases page](https://github.com/gorhill/uBlock/releases), then drag-n-drop it into Thunderbird's Add-ons Manager pane (Thunderbird 91+ required).
29+
- **Chromium**: Install from the [Chrome Web Store](https://chromewebstore.google.com/detail/ublock-origin-development/cgbcahbpdhpcegmbfconppldiemgcoii).
30+
- **Firefox**: Download the latest `uBlock0_[version].firefox.signed.xpi` file from the [uBO Releases page](https://github.com/gorhill/uBlock/releases).
31+
- **Thunderbird**: Download the latest `uBlock0_[version].thunderbird.xpi` from the [uBO Releases page](https://github.com/gorhill/uBlock/releases) and drag-and-drop it into Thunderbird's Add-ons Manager pane (Thunderbird 91+ required).

0 commit comments

Comments
 (0)