From 0b79b4b6b45b7ab851fee7eb811c5dcc37cd2b01 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 4 Jul 2024 09:09:23 +0000 Subject: [PATCH 01/16] Bump actions/checkout from 4.1.6 to 4.1.7 Bumps [actions/checkout](https://github.com/actions/checkout) from 4.1.6 to 4.1.7. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v4.1.6...692973e3d937129bcbf40652eb9f2f61becf3332) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- .github/workflows/build_blocklist.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build_blocklist.yml b/.github/workflows/build_blocklist.yml index a33aa66..363060e 100644 --- a/.github/workflows/build_blocklist.yml +++ b/.github/workflows/build_blocklist.yml @@ -25,7 +25,7 @@ jobs: id: extract_branch - name: Checkout branch - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 #@v4.1.6 + uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 #@v4.1.7 with: ref: ${{ steps.extract_branch.outputs.branch }} path: ${{ steps.extract_branch.outputs.branch }} From ebbf6017df327abb2af51885829291ff912f4a06 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 4 Jul 2024 09:09:25 +0000 Subject: [PATCH 02/16] Bump actions/stale from 5 to 9 Bumps [actions/stale](https://github.com/actions/stale) from 5 to 9. - [Release notes](https://github.com/actions/stale/releases) - [Changelog](https://github.com/actions/stale/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/stale/compare/v5...v9) --- updated-dependencies: - dependency-name: actions/stale dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/stale.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 3262d4a..faac6dd 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -18,7 +18,7 @@ jobs: pull-requests: write steps: - - uses: actions/stale@v5 + - uses: actions/stale@v9 with: repo-token: ${{ secrets.GITHUB_TOKEN }} stale-issue-message: 'Stale issue message' From 870b2fd48ca590c41a45be25245f8333e1cd4f86 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isaac=20Hern=C3=A1n?= <77550577+Isaaker@users.noreply.github.com> Date: Thu, 4 Jul 2024 11:17:32 +0200 Subject: [PATCH 03/16] Make some changes to comply with repolinter --- .../pull_request_template.md | 11 +++++++ .../{contributing.md => docs_contributing.md} | 0 docs/{faq.md => docs_faq.md} | 0 docs/{index.md => docs_index.md} | 0 .../{installation.md => docs_installation.md} | 0 docs/{license.md => docs_license.md} | 0 docs/{testing.md => docs_testing.md} | 0 mkdocs.yml | 30 +++++++++---------- 8 files changed, 26 insertions(+), 15 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md rename docs/{contributing.md => docs_contributing.md} (100%) rename docs/{faq.md => docs_faq.md} (100%) rename docs/{index.md => docs_index.md} (100%) rename docs/{installation.md => docs_installation.md} (100%) rename docs/{license.md => docs_license.md} (100%) rename docs/{testing.md => docs_testing.md} (100%) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..a3ab055 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,11 @@ +Please check these requirements: +**pull requests that do not meet these requirements will not be accepted under any circumstances** +- [ ] The content I want to contribute is appropriate ([Read more](https://github.com/Isaaker/piscinadeentropia/blob/main/CONTRIBUTING.md)) +- [ ] I agree that my contributions are licensed and I accept the [terms and conditions of the license](https://github.com/Isaaker/piscinadeentropia/blob/main/LICENSE.txt) +- [ ] I accept the [code of conduct](https://github.com/Isaaker/piscinadeentropia/blob/main/CODE_OF_CONDUCT) +- [ ] I read the documentation on [how to contribute](https://github.com/Isaaker/piscinadeentropia/blob/main/CONTRIBUTING.md) +- [ ] I have checked that the pull is not being performed against main + +* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...) + +* **Other information**: (Closes # xxx ) \ No newline at end of file diff --git a/docs/contributing.md b/docs/docs_contributing.md similarity index 100% rename from docs/contributing.md rename to docs/docs_contributing.md diff --git a/docs/faq.md b/docs/docs_faq.md similarity index 100% rename from docs/faq.md rename to docs/docs_faq.md diff --git a/docs/index.md b/docs/docs_index.md similarity index 100% rename from docs/index.md rename to docs/docs_index.md diff --git a/docs/installation.md b/docs/docs_installation.md similarity index 100% rename from docs/installation.md rename to docs/docs_installation.md diff --git a/docs/license.md b/docs/docs_license.md similarity index 100% rename from docs/license.md rename to docs/docs_license.md diff --git a/docs/testing.md b/docs/docs_testing.md similarity index 100% rename from docs/testing.md rename to docs/docs_testing.md diff --git a/mkdocs.yml b/mkdocs.yml index f747886..23f0b65 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -53,23 +53,23 @@ plugins: match_path: "./*" nav: - - Home: index.md - - Installation: installation.md + - Home: docs_index.md + - Installation: docs_installation.md - Versions: - - "Standard": "standard.md" - - "Pi-Hole": "pihole.md" - - "Dnsmasq": "dnsmasq.md" - - "Adguard": "adguard.md" - - Whitelist: whitelist.md - - Testing: testing.md + - "Standard": "docs_standard.md" + - "Pi-Hole": "docs_pihole.md" + - "Dnsmasq": "docs_dnsmasq.md" + - "Adguard": "docs_adguard.md" + - Whitelist: docs_whitelist.md + - Testing: docs_testing.md - Docs: - - "F.A.Q": "faq.md" - - "How Spotify send ads?": "how_spotify_ads.md" - - "How adblockers work?": "how_adblockers_work.md" - - "Why to add aditional blocklists": "why_add_more_blocklists.md" + - "F.A.Q": "docs_faq.md" + - "How Spotify send ads?": "docs_how_spotify_ads.md" + - "How adblockers work?": "docs_how_adblockers_work.md" + - "Why to add aditional blocklists": "docs_why_add_more_blocklists.md" - About: - - "About": about.md - - "License": license.md - - "Contributing.md": contributing.md + - "About": docs_about.md + - "License": docs_license.md + - "Contributing.md": docs_contributing.md - Report Bug: https://github.com/Isaaker/Spotify-AdsList/issues \ No newline at end of file From 7ddf276cf05c2e2e9ab4dc6b4235378e5d19c173 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isaac=20Hern=C3=A1n?= <77550577+Isaaker@users.noreply.github.com> Date: Thu, 4 Jul 2024 11:18:34 +0200 Subject: [PATCH 04/16] Rename requeriments.txt to requirements.txt MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Isaac Hernán <77550577+Isaaker@users.noreply.github.com> --- requeriments.txt => requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename requeriments.txt => requirements.txt (85%) diff --git a/requeriments.txt b/requirements.txt similarity index 85% rename from requeriments.txt rename to requirements.txt index 90bddf1..c94de09 100644 --- a/requeriments.txt +++ b/requirements.txt @@ -4,4 +4,4 @@ mkdocs-material>=9.5.11 mkdocs-redirects>=1.2.0 mkdocs-static-i18n>=0.56 mkdocs-simple-hooks>=0.1.5 -mkdocs-rss-plugin>=1.7.0 \ No newline at end of file +mkdocs-rss-plugin>=1.7.0 From 3f5d982b624215639b653692397f186bf09617bc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isaac=20Hern=C3=A1n?= <77550577+Isaaker@users.noreply.github.com> Date: Thu, 4 Jul 2024 11:23:08 +0200 Subject: [PATCH 05/16] Update mkdocs.yml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Isaac Hernán <77550577+Isaaker@users.noreply.github.com> --- mkdocs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 23f0b65..15c8cd5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,7 @@ site_name: Spotify-AdsList site_url: https://spotify.piscinadeentropia.es site_description: No more spotify ADS -copyright: © Creative Commons Attribution-ShareAlike 4.0 International Public License | Reproduction and/or distribution, in whole or in part, and use in Artificial Intelligence is strictly prohibited +copyright: License: Creative Commons Attribution-ShareAlike 4.0 International Public License | Reproduction and/or distribution, in whole or in part, and use in Artificial Intelligence is strictly prohibited theme: name: material @@ -72,4 +72,4 @@ nav: - "License": docs_license.md - "Contributing.md": docs_contributing.md - Report Bug: https://github.com/Isaaker/Spotify-AdsList/issues - \ No newline at end of file + From e8bb1759aaac7a36a31806baa3b5c027a99508d0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isaac=20Hern=C3=A1n?= <77550577+Isaaker@users.noreply.github.com> Date: Thu, 4 Jul 2024 11:24:46 +0200 Subject: [PATCH 06/16] Update mkdocs.yml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Isaac Hernán <77550577+Isaaker@users.noreply.github.com> --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 15c8cd5..b90d18a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,7 @@ site_name: Spotify-AdsList site_url: https://spotify.piscinadeentropia.es site_description: No more spotify ADS -copyright: License: Creative Commons Attribution-ShareAlike 4.0 International Public License | Reproduction and/or distribution, in whole or in part, and use in Artificial Intelligence is strictly prohibited +copyright: License Creative Commons Attribution-ShareAlike 4.0 International Public License | Reproduction and/or distribution, in whole or in part, and use in Artificial Intelligence is strictly prohibited theme: name: material From a8abac117b6c3e4a8ce37a115d6616aac207cfd8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isaac=20Hern=C3=A1n?= <77550577+Isaaker@users.noreply.github.com> Date: Thu, 4 Jul 2024 11:34:23 +0200 Subject: [PATCH 07/16] Make changes on docs --- docs/docs_faq.md | 2 +- docs/docs_index.md | 2 +- docs/docs_installation.md | 2 +- {images => docs/images}/License-Image.jpeg | Bin {images => docs/images}/ads_space.png | Bin {images => docs/images}/spotify_ads_list_logo.png | Bin {images => docs/images}/tutorial.gif | Bin 7 files changed, 3 insertions(+), 3 deletions(-) rename {images => docs/images}/License-Image.jpeg (100%) rename {images => docs/images}/ads_space.png (100%) rename {images => docs/images}/spotify_ads_list_logo.png (100%) rename {images => docs/images}/tutorial.gif (100%) diff --git a/docs/docs_faq.md b/docs/docs_faq.md index 7ea38b5..7ef7319 100644 --- a/docs/docs_faq.md +++ b/docs/docs_faq.md @@ -6,7 +6,7 @@ Here you can find some frequently asked questions and answers about our blocklis Although our blockoblocklist blocks banner and image ads, Spotify's apps continue to reserve a space to place these ads, and since Spotify can't get those ads and banners, they will continue to appear in black. -![Space Example](../images/ads_space.png) +![Space Example](./images/ads_space.png) ## Why do I sometimes get a message "This content cannot be played at this time? diff --git a/docs/docs_index.md b/docs/docs_index.md index 41e4f38..87a61ad 100644 --- a/docs/docs_index.md +++ b/docs/docs_index.md @@ -1,5 +1,5 @@ # Spotify Ads List -![Spotify Ads List Logo](../images/spotify_ads_list_logo.png) +![Spotify Ads List Logo](./images/spotify_ads_list_logo.png) **🔼 Use the menu at the top to navigate 🔼** \ No newline at end of file diff --git a/docs/docs_installation.md b/docs/docs_installation.md index 5b56f2c..33f096c 100644 --- a/docs/docs_installation.md +++ b/docs/docs_installation.md @@ -1,6 +1,6 @@ # Spotify Ads List Tutorial -![Spotify Block Tutorial Logo](../images/tutorial.gif) +![Spotify Block Tutorial Logo](./images/tutorial.gif) Spotify Ads List is quick and easy to install, all you need is a compatible adblocker, an internet connection and the Spotify website or app. diff --git a/images/License-Image.jpeg b/docs/images/License-Image.jpeg similarity index 100% rename from images/License-Image.jpeg rename to docs/images/License-Image.jpeg diff --git a/images/ads_space.png b/docs/images/ads_space.png similarity index 100% rename from images/ads_space.png rename to docs/images/ads_space.png diff --git a/images/spotify_ads_list_logo.png b/docs/images/spotify_ads_list_logo.png similarity index 100% rename from images/spotify_ads_list_logo.png rename to docs/images/spotify_ads_list_logo.png diff --git a/images/tutorial.gif b/docs/images/tutorial.gif similarity index 100% rename from images/tutorial.gif rename to docs/images/tutorial.gif From f9de580c32b5e6f660cd53b1a6cf6b31f4cca610 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isaac=20Hern=C3=A1n?= <77550577+Isaaker@users.noreply.github.com> Date: Thu, 4 Jul 2024 11:38:39 +0200 Subject: [PATCH 08/16] Update mkdocs.yml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Isaac Hernán <77550577+Isaaker@users.noreply.github.com> --- mkdocs.yml | 9 --------- 1 file changed, 9 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index b90d18a..0c0e319 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -43,15 +43,6 @@ plugins: - mkdocs-simple-hooks: hooks: on_config: "hooks.on_config:deploy_hooks" - - rss: - date_from_meta: - as_creation: "date" - as_update: false - datetime_format: "%Y-%m-%d" - pretty_print: !ENV [PRETTY_RSS, false] - length: 30 - match_path: "./*" - nav: - Home: docs_index.md - Installation: docs_installation.md From 490fc17c2f22913fa95087689b70a47f99366fd9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isaac=20Hern=C3=A1n?= <77550577+Isaaker@users.noreply.github.com> Date: Thu, 4 Jul 2024 12:16:43 +0200 Subject: [PATCH 09/16] Add & update some docs --- Lists/WHITELIST.md | 4 +-- docs/docs_installation.md | 58 +++++++++++++++++++------------- docs/docs_testing.md | 3 +- docs/docs_whitelist.md | 34 +++++++++++++++++++ docs/{docs_index.md => index.md} | 3 +- mkdocs.yml | 13 ++++--- 6 files changed, 83 insertions(+), 32 deletions(-) create mode 100644 docs/docs_whitelist.md rename docs/{docs_index.md => index.md} (58%) diff --git a/Lists/WHITELIST.md b/Lists/WHITELIST.md index 63fcec8..b1ca098 100644 --- a/Lists/WHITELIST.md +++ b/Lists/WHITELIST.md @@ -2,11 +2,11 @@ Created by: Isaaker -Revised: 16/5/23 +Revised: 4/7/23 Version: WHITELIST -Number of domains: 4 +Number of domains: 5 Read more: https://github.com/Isaaker/Spotify-AdsList diff --git a/docs/docs_installation.md b/docs/docs_installation.md index 33f096c..47f6e07 100644 --- a/docs/docs_installation.md +++ b/docs/docs_installation.md @@ -17,7 +17,8 @@ The currently supported adblockers are: - [Adguard](https://adguard.com/es/welcome.html) - [uBlock Origin](https://ublockorigin.com) -**Being a simple and very backward compatible list, if your adblocker is not included above, you can ask us to include it and if necessary to generate a custom list layout for it.** +!!! tip: + Being a simple and very backward compatible list, if your adblocker is not included above, you can ask us to include it and if necessary to generate a custom list layout for it. ## 2. Find the right list format @@ -33,7 +34,8 @@ Here is a table to find the right format for your adblcoker: | uBlock Origin | Adguard | | Standard (with hosts file or adblockers that supports 0.0.0.0 entry) | Standard | -**Being a simple and very backward compatible list, if your adblocker is not included above, you can ask us to include it and if necessary to generate a custom list layout for it.** +!!! tip: + Being a simple and very backward compatible list, if your adblocker is not included above, you can ask us to include it and if necessary to generate a custom list layout for it. ## 3. (Optional) Setup your adblocker & Spotify @@ -64,12 +66,22 @@ To add Spotify Ads List to your adblocker you will need to make use of a raw fil # Standard adblockers -| Adblocker | Raw URL | How to add this? | -| -- | -- | -- | -| Standard | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/standard_list.txt | Not applicable, unless you want to use the hosts file. In that case, [read this](https://nordvpn.com/es/blog/use-hosts-file-block-ads-malware/) | -| Pi-hole | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/pi-hole.txt | Not official documentation for this, go to the Web UI, in the left bar click on "Adlists", enter the raw url and click "Add" | -| Dnsmasq | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/dnsmasq.txt | There is not much official documentation, perhaps [this will help](https://dnsmasq.org/docs/dnsmasq-man.html) | -| Adguard | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/adguard.txt | [Read this](https://adguard.com/kb/) | +| Adblocker | Raw URL +| -- | -- | +| Standard | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/standard_list.txt | +| Pi-hole | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/pi-hole.txt | +| Dnsmasq | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/dnsmasq.txt | +| Adguard | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/adguard.txt | + +!!! question inline end "How can I do this?": + You can find more help about how to add this on this links: + + | Adblocker | Link | + |--|--| + | Standard | Not applicable, unless you want to use the hosts file. In that case, [read this](https://nordvpn.com/es/blog/use-hosts-file-block-ads-malware/) | + | Pi-hole | Not official documentation for this, go to the Web UI, in the left bar click on "Adlists", enter the raw url and click "Add" | + | Dnsmasq | There is not much official documentation, perhaps [this will help](https://dnsmasq.org/docs/dnsmasq-man.html) | + | Adguard | [Read this](https://adguard.com/kb/) | ### Browser adblockers @@ -80,28 +92,26 @@ To add Spotify Ads List to your adblocker you will need to make use of a raw fil | Firefox | moz-extension://c396fed9-d8f8-4a6c-95a0-80773fa36d8a/asset-viewer.html?url=https%3A%2F%2Fraw.githubusercontent.com%2Fisaaker%2FSpotify-AdsList%2Fmain%2FLists%2Fadguard.txt&title=Spotify-AdsList&subscribe=1 | | Chrome / Chromium | chrome-extension://cjpalhdlnbpafiamejdnhcphjbkeiagm/asset-viewer.html?url=https%3A%2F%2Fraw.githubusercontent.com%2Fisaaker%2FSpotify-AdsList%2Fmain%2FLists%2Fadguard.txt&title=Spotify-AdsList&subscribe=1 | -[You can also make this manually with the adguard raw URL](https://github.com/gorhill/uBlock/wiki/Dashboard:-Filter-lists#3rd-party-filter-lists) +!!! tip: + [You can also make this manually with the adguard raw URL](https://github.com/gorhill/uBlock/wiki/Dashboard:-Filter-lists#3rd-party-filter-lists) ## 5. Add Spotify Ads List whitelist to your adblocker -A whitelist is a list that lets your adblocker know which domains should not be blocked. Although usually these domains are not added to the list directly, many times some domains that are on the list (blocked) redirect legitimate requests to these domains (not blocked) via a CNAME and these requests are blocked before being redirected because it is a blocked domain. Therefore, the list will help you to ensure that legitimate requests can continue their course correctly. +To add the whitelist to your adblocker, you have to enter the whitelist domains manually in the whitelist area. You can found the whitelist on this [link](./docs_whitelist.md) -To add the whitelist to your adblocker, you have to enter this domains manually in the whitelist area: +!!! question inline end "How can I do this?": + You can find more help about how to add this on this links: -- login5.spotify.com -- spclient.wg.spotify.com -- open.spotify.com -- api-partner.spotify.com + | Adblocker | Link | + |--|--| + | Standard | This is not possible in the hosts file, for other methods please consult your adblocker documentation | + | Pi-hole | [Read this](https://discourse.pi-hole.net/t/how-do-i-whitelist-or-blacklist-a-domain/244), you can also make this form the Web UI > Domains | + | Dnsmasq | Not docs of this available | + | Adguard | [Read this](https://github.com/AdguardTeam/AdGuardHome/discussions/3771) | + | uBlock Origin | [Read this](https://github.com/gorhill/uBlock/wiki/How-to-whitelist-a-web-site/745c6f01e1f88db8184bb27f48bbdd8a21b48a90) | -You can find more help about how to add this on this links: - -| Adblocker | Link | -|--|--| -| Standard | This is not possible in the hosts file, for other methods please consult your adblocker documentation | -| Pi-hole | [Read this](https://discourse.pi-hole.net/t/how-do-i-whitelist-or-blacklist-a-domain/244), you can also make this form the Web UI > Domains | -| Dnsmasq | Not docs of this available | -| Adguard | [Read this](https://github.com/AdguardTeam/AdGuardHome/discussions/3771) | -| uBlock Origin | [Read this](https://github.com/gorhill/uBlock/wiki/How-to-whitelist-a-web-site/745c6f01e1f88db8184bb27f48bbdd8a21b48a90) | +!!! info: + A whitelist is a list that lets your adblocker know which domains should not be blocked. Although usually these domains are not added to the list directly, many times some domains that are on the list (blocked) redirect legitimate requests to these domains (not blocked) via a CNAME and these requests are blocked before being redirected because it is a blocked domain. Therefore, the list will help you to ensure that legitimate requests can continue their course correctly. ## 6. What can I do now? diff --git a/docs/docs_testing.md b/docs/docs_testing.md index a036516..0c1e3ac 100644 --- a/docs/docs_testing.md +++ b/docs/docs_testing.md @@ -15,4 +15,5 @@ Here you can find all the tests made, their date and more details. | App | Windows Laptop | Windows 11 (10.0.22631) | - | 26/6/24 | ![Static Badge](https://img.shields.io/badge/Status-ERROR-red?logo=spotify) | pihole | @MW-SAND | | Web App | Windows Computer | Windows (22H2 19045.4170) | Chrome (126.0.6478.127 (64 bits)) | 29/6/24 | ![Static Badge](https://img.shields.io/badge/Status-ERROR-red?logo=spotify) | ublock origin | @AlkBek | -**If you have tested the list, please create a issue with type "Testing" to add more tested devices. [Add new tested device](https://github.com/Isaaker/Spotify-AdsList/issues/new?assignees=&labels=Testing&projects=&template=testing.yml&title=New+Testing+Device%3A+%5BDevice+Name%5D+%2F+%5BDevice+OS%26Version%5D)** \ No newline at end of file +!!! info: + If you have tested the list, please create a issue with type "Testing" to add more tested devices. [Add new tested device](https://github.com/Isaaker/Spotify-AdsList/issues/new?assignees=&labels=Testing&projects=&template=testing.yml&title=New+Testing+Device%3A+%5BDevice+Name%5D+%2F+%5BDevice+OS%26Version%5D) \ No newline at end of file diff --git a/docs/docs_whitelist.md b/docs/docs_whitelist.md new file mode 100644 index 0000000..f69011c --- /dev/null +++ b/docs/docs_whitelist.md @@ -0,0 +1,34 @@ +# Spotify Ads Whitelist + +!!! info: + Created by: Isaaker + + Revised: 4/7/23 + + Version: WHITELIST + + Number of domains: 5 + + +!!! warning: + This list is not formatted in any special way and therefore cannot be downloaded and used as an input file, please add the domains manually. + +## Detailed list + +| Domain | Explanation | What happens when it is blocked? | +| -- | -- | -- | +| login5.spotify.com | Spotify login domain | Unable to log in to Spotify no audio is played and many screens cannot be accessed | +| spclient.wg.spotify.com | Spotify domain providing music and controlling it | The player does not work, it is impossible to control the audio playback and this causes it to skip songs continuously and without stopping | +| open.spotify.com | In principle, I have not observed any adverse effect on the applications when blocking this domain, however, blocking it makes it impossible to access the spotify web platform | Unable to access the spotify web player | +| api-partner.spotify.com | This domain is the one that provides some of the main images of the app such as the home screen, the application will continue to play music but some screens may not work properly or may be inaccessible by displaying an error. | Problems displaying images | +| partners.wg.spotify.com | This domain is the one that provides some of the main images of the app such as the home screen, the application will continue to play music but some screens may not work properly or may be inaccessible by displaying an error. | Problems displaying images | +| api.spotify.com | Spotify main API | + +## Plain List + +- login5.spotify.com +- spclient.wg.spotify.com +- open.spotify.com +- api-partner.spotify.com +- partners.wg.spotify.com +- api.spotify.com \ No newline at end of file diff --git a/docs/docs_index.md b/docs/index.md similarity index 58% rename from docs/docs_index.md rename to docs/index.md index 87a61ad..4db03d5 100644 --- a/docs/docs_index.md +++ b/docs/index.md @@ -2,4 +2,5 @@ ![Spotify Ads List Logo](./images/spotify_ads_list_logo.png) -**🔼 Use the menu at the top to navigate 🔼** \ No newline at end of file +!!! tip: + 🔼 Use the menu at the top to navigate 🔼 \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 0c0e319..a1928f6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,8 @@ -site_name: Spotify-AdsList +site_name: Spotify Ads List site_url: https://spotify.piscinadeentropia.es site_description: No more spotify ADS copyright: License Creative Commons Attribution-ShareAlike 4.0 International Public License | Reproduction and/or distribution, in whole or in part, and use in Artificial Intelligence is strictly prohibited +repo_url: https://github.com/Isaaker/Spotify-AdsList/ theme: name: material @@ -11,12 +12,13 @@ theme: font: text: Ubuntu code: IBM Plex Mono + icon: + repo: fontawesome/brands/github features: - navigation.tabs - navigation.tabs.sticky - navigation.sections - navigation.top - - navigation.footer - search.suggest palette: - primary: green @@ -44,7 +46,7 @@ plugins: hooks: on_config: "hooks.on_config:deploy_hooks" nav: - - Home: docs_index.md + - Home: index.md - Installation: docs_installation.md - Versions: - "Standard": "docs_standard.md" @@ -63,4 +65,7 @@ nav: - "License": docs_license.md - "Contributing.md": docs_contributing.md - Report Bug: https://github.com/Isaaker/Spotify-AdsList/issues - +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/Isaaker/Spotify-AdsList/ From d36eb87824e15dcd8b4e9dbb7a02d59dda7d14c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isaac=20Hern=C3=A1n?= <77550577+Isaaker@users.noreply.github.com> Date: Thu, 4 Jul 2024 12:20:20 +0200 Subject: [PATCH 10/16] Add pymdownx.details for admonition --- mkdocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/mkdocs.yml b/mkdocs.yml index a1928f6..e1e74e7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -30,6 +30,7 @@ markdown_extensions: - meta - toc: permalink: true + - pymdownx.details - pymdownx.emoji: emoji_index: !!python/name:materialx.emoji.twemoji emoji_generator: !!python/name:materialx.emoji.to_svg From f02e59d52588522462bb360b00d2d2966ab57f9c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isaac=20Hern=C3=A1n?= <77550577+Isaaker@users.noreply.github.com> Date: Thu, 4 Jul 2024 12:25:01 +0200 Subject: [PATCH 11/16] Update Admonitions --- docs/docs_faq.md | 9 ++++++--- docs/docs_installation.md | 12 ++++++------ docs/docs_testing.md | 2 +- docs/docs_whitelist.md | 4 ++-- docs/index.md | 2 +- 5 files changed, 16 insertions(+), 13 deletions(-) diff --git a/docs/docs_faq.md b/docs/docs_faq.md index 7ef7319..83dec18 100644 --- a/docs/docs_faq.md +++ b/docs/docs_faq.md @@ -4,14 +4,17 @@ Here you can find some frequently asked questions and answers about our blocklis ## Why do black spaces continue to appear where the advertisements were before? -Although our blockoblocklist blocks banner and image ads, Spotify's apps continue to reserve a space to place these ads, and since Spotify can't get those ads and banners, they will continue to appear in black. +!!! question inline end "Answer" + Although our blockoblocklist blocks banner and image ads, Spotify's apps continue to reserve a space to place these ads, and since Spotify can't get those ads and banners, they will continue to appear in black. ![Space Example](./images/ads_space.png) ## Why do I sometimes get a message "This content cannot be played at this time? -When Spotify tries to display an ad, it changes the name of the song to Advertisement, and attempts to load the audio and images from the ad. However, since it is unable to get this content through the blocklist, Spotify will resume playing music as normal. +!!! question inline end "Answer" + When Spotify tries to display an ad, it changes the name of the song to Advertisement, and attempts to load the audio and images from the ad. However, since it is unable to get this content through the blocklist, Spotify will resume playing music as normal. ## Why does Spotify sometimes take longer to load or behave strangely? -Although this list is safe and cannot damage your Spotify or your computer in any way. Sometimes Spotify may take a little bit longer to load or have some weird behavior, because the application is actually trying to continuously contact some ad domains, tracking, which are usually constantly changing to find unblocked domains. And this can sometimes change the behavior of the application a little bit. \ No newline at end of file +!!! question inline end "Answer" + Although this list is safe and cannot damage your Spotify or your computer in any way. Sometimes Spotify may take a little bit longer to load or have some weird behavior, because the application is actually trying to continuously contact some ad domains, tracking, which are usually constantly changing to find unblocked domains. And this can sometimes change the behavior of the application a little bit. \ No newline at end of file diff --git a/docs/docs_installation.md b/docs/docs_installation.md index 47f6e07..5a2168a 100644 --- a/docs/docs_installation.md +++ b/docs/docs_installation.md @@ -17,7 +17,7 @@ The currently supported adblockers are: - [Adguard](https://adguard.com/es/welcome.html) - [uBlock Origin](https://ublockorigin.com) -!!! tip: +!!! tip Being a simple and very backward compatible list, if your adblocker is not included above, you can ask us to include it and if necessary to generate a custom list layout for it. ## 2. Find the right list format @@ -34,7 +34,7 @@ Here is a table to find the right format for your adblcoker: | uBlock Origin | Adguard | | Standard (with hosts file or adblockers that supports 0.0.0.0 entry) | Standard | -!!! tip: +!!! tip Being a simple and very backward compatible list, if your adblocker is not included above, you can ask us to include it and if necessary to generate a custom list layout for it. ## 3. (Optional) Setup your adblocker & Spotify @@ -73,7 +73,7 @@ To add Spotify Ads List to your adblocker you will need to make use of a raw fil | Dnsmasq | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/dnsmasq.txt | | Adguard | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/adguard.txt | -!!! question inline end "How can I do this?": +!!! question inline end "How can I do this?" You can find more help about how to add this on this links: | Adblocker | Link | @@ -92,14 +92,14 @@ To add Spotify Ads List to your adblocker you will need to make use of a raw fil | Firefox | moz-extension://c396fed9-d8f8-4a6c-95a0-80773fa36d8a/asset-viewer.html?url=https%3A%2F%2Fraw.githubusercontent.com%2Fisaaker%2FSpotify-AdsList%2Fmain%2FLists%2Fadguard.txt&title=Spotify-AdsList&subscribe=1 | | Chrome / Chromium | chrome-extension://cjpalhdlnbpafiamejdnhcphjbkeiagm/asset-viewer.html?url=https%3A%2F%2Fraw.githubusercontent.com%2Fisaaker%2FSpotify-AdsList%2Fmain%2FLists%2Fadguard.txt&title=Spotify-AdsList&subscribe=1 | -!!! tip: +!!! tip [You can also make this manually with the adguard raw URL](https://github.com/gorhill/uBlock/wiki/Dashboard:-Filter-lists#3rd-party-filter-lists) ## 5. Add Spotify Ads List whitelist to your adblocker To add the whitelist to your adblocker, you have to enter the whitelist domains manually in the whitelist area. You can found the whitelist on this [link](./docs_whitelist.md) -!!! question inline end "How can I do this?": +!!! question inline end "How can I do this?" You can find more help about how to add this on this links: | Adblocker | Link | @@ -110,7 +110,7 @@ To add the whitelist to your adblocker, you have to enter the whitelist domains | Adguard | [Read this](https://github.com/AdguardTeam/AdGuardHome/discussions/3771) | | uBlock Origin | [Read this](https://github.com/gorhill/uBlock/wiki/How-to-whitelist-a-web-site/745c6f01e1f88db8184bb27f48bbdd8a21b48a90) | -!!! info: +!!! info A whitelist is a list that lets your adblocker know which domains should not be blocked. Although usually these domains are not added to the list directly, many times some domains that are on the list (blocked) redirect legitimate requests to these domains (not blocked) via a CNAME and these requests are blocked before being redirected because it is a blocked domain. Therefore, the list will help you to ensure that legitimate requests can continue their course correctly. ## 6. What can I do now? diff --git a/docs/docs_testing.md b/docs/docs_testing.md index 0c1e3ac..37ef1d7 100644 --- a/docs/docs_testing.md +++ b/docs/docs_testing.md @@ -15,5 +15,5 @@ Here you can find all the tests made, their date and more details. | App | Windows Laptop | Windows 11 (10.0.22631) | - | 26/6/24 | ![Static Badge](https://img.shields.io/badge/Status-ERROR-red?logo=spotify) | pihole | @MW-SAND | | Web App | Windows Computer | Windows (22H2 19045.4170) | Chrome (126.0.6478.127 (64 bits)) | 29/6/24 | ![Static Badge](https://img.shields.io/badge/Status-ERROR-red?logo=spotify) | ublock origin | @AlkBek | -!!! info: +!!! info If you have tested the list, please create a issue with type "Testing" to add more tested devices. [Add new tested device](https://github.com/Isaaker/Spotify-AdsList/issues/new?assignees=&labels=Testing&projects=&template=testing.yml&title=New+Testing+Device%3A+%5BDevice+Name%5D+%2F+%5BDevice+OS%26Version%5D) \ No newline at end of file diff --git a/docs/docs_whitelist.md b/docs/docs_whitelist.md index f69011c..34d0761 100644 --- a/docs/docs_whitelist.md +++ b/docs/docs_whitelist.md @@ -1,6 +1,6 @@ # Spotify Ads Whitelist -!!! info: +!!! info Created by: Isaaker Revised: 4/7/23 @@ -10,7 +10,7 @@ Number of domains: 5 -!!! warning: +!!! warning This list is not formatted in any special way and therefore cannot be downloaded and used as an input file, please add the domains manually. ## Detailed list diff --git a/docs/index.md b/docs/index.md index 4db03d5..a14b674 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,5 +2,5 @@ ![Spotify Ads List Logo](./images/spotify_ads_list_logo.png) -!!! tip: +!!! tip 🔼 Use the menu at the top to navigate 🔼 \ No newline at end of file From 27d3b5bb4c804785f8010c9826c759d6c1e3e1d8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isaac=20Hern=C3=A1n?= <77550577+Isaaker@users.noreply.github.com> Date: Thu, 4 Jul 2024 15:57:56 +0200 Subject: [PATCH 12/16] Update documentation --- README.md | 6 ++--- docs/docs_about.md | 7 ++++++ docs/docs_contributing.md | 41 ++++++++++++++++++++--------------- docs/docs_faq.md | 6 ++--- docs/docs_installation.md | 36 +++++++++++++++--------------- docs/images/contributing.svg | 18 +++++++++++++++ docs/images/standard_logo.svg | 10 +++++++++ docs/versions_standard.md | 17 +++++++++++++++ mkdocs.yml | 4 ++-- 9 files changed, 101 insertions(+), 44 deletions(-) create mode 100644 docs/docs_about.md create mode 100644 docs/images/contributing.svg create mode 100644 docs/images/standard_logo.svg create mode 100644 docs/versions_standard.md diff --git a/README.md b/README.md index 762ec6b..255280a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Spotify Ads List -![Spotify-AdsList Logo](https://github.com/Isaaker/Spotify-AdsList/raw/main/images/spotify_ads_list_logo.png) +![Spotify-AdsList Logo](https://github.com/Isaaker/Spotify-AdsList/raw/main/docs/images/spotify_ads_list_logo.png) ## Workflows @@ -13,7 +13,7 @@ ## About -![maintained - yes](https://img.shields.io/badge/maintained-yes-blue)[![contributions - welcome](https://img.shields.io/badge/contributions-welcome-blue)](/CONTRIBUTING.md "Go to contributions doc") +![maintained - yes](https://img.shields.io/badge/maintained-yes-blue)[![Contributions - Welcome](https://img.shields.io/badge/contributions-welcome-blue)](https://spotify.piscinadeentropia.es/docs_contributing/) Spotify Ads List is a list of domains that includes all the domains from which Spotify Apps get audio ads, banners... @@ -79,7 +79,7 @@ Here you can find all the tests made, their date and more details. ## License The code is under **Creative Commons Attribution-ShareAlike 4.0 International Public License**, view the [license here](https://spotify.piscinadeentropia.es/license) -![Creative Commons Attribution-ShareAlike 4.0 International Public License Logo](https://github.com/Isaaker/Spotify-AdsList/raw/main/images/License-Image.jpeg) +![Creative Commons Attribution-ShareAlike 4.0 International Public License Logo](https://github.com/Isaaker/Spotify-AdsList/raw/main/docs/images/License-Image.jpeg) ## Contributing diff --git a/docs/docs_about.md b/docs/docs_about.md new file mode 100644 index 0000000..0ddaaf4 --- /dev/null +++ b/docs/docs_about.md @@ -0,0 +1,7 @@ +# About + +Spotify Ads List is a list of domains that includes all the domains from which Spotify Apps get audio ads, banners... + +Blocking these domains is totally legal since the only thing you are doing is redirecting requests from these domains to 0.0.0.0 also known as nowhere. + +Making the list cost me a lot of time but finally it seems to work, in case you find any false positive let me know by creating an Issue, also if you want to collaborate I invite you to create a fork of the repository. \ No newline at end of file diff --git a/docs/docs_contributing.md b/docs/docs_contributing.md index e26498e..86c9bd6 100644 --- a/docs/docs_contributing.md +++ b/docs/docs_contributing.md @@ -1,31 +1,35 @@ # Contributing -**Always read the license and code of conduct before contributing, once the changes you have made are added to the source repository they will be licensed under the source repository license** +![Contributing image](./images/contributing.svg) + +!!! warning + Always read the license and code of conduct before contributing, once the changes you have made are added to the source repository they will be licensed under the source repository license ## Content to collaborate with This repository is a blocklist for Spotify Ads, therefore, the following contents are acceptable as a contribution: -Accepted contents: +### Accepted contents: -- Spelling corrections -- Corrections of images or videos that are not displayed correctly -- Invalid domain correction -- New list format -- Add new domains to the blocklist -- Add new domains to the whitelist +* Spelling corrections +* Corrections of images or videos that are not displayed correctly +* Invalid domain correction +* New list format +* Add new domains to the blocklist +* Add new domains to the whitelist -Not accepted contents: +### Not accepted contents: -- Comments (for SPAM prevention) -- Ads of any kind -- Self-Promoting -- Posts or articles of your own creation -- Any kind of sensitive content -- Any type of content containing personal information of any person -- Any kind of software (as this repository is oriented to a website and not to software distribution) +* Comments (for SPAM prevention) +* Ads of any kind +* Self-Promoting +* Posts or articles of your own creation +* Any kind of sensitive content +* Any type of content containing personal information of any person +* Any kind of software (as this repository is oriented to a website and not to software distribution) -**If you are in doubt as to whether a piece of content is suitable to be added to this repository, please contact us through the contact section of the website** +!!! warning + If you are in doubt as to whether a piece of content is suitable to be added to this repository, please contact us through the contact section of the website ## How to colaborate @@ -34,4 +38,5 @@ You can colaborate in this ways: - [Opening a Issue](https://github.com/Isaaker/Spotify-AdsList/issues/new/choose) - [Making a Fork](https://github.com/Isaaker/Spotify-AdsList/fork) and later opening a Pull Request to the Developer branch of the origin repository -**⚠️Please, make changes only on BLACKLIST.txt (Don't put extra lines or comments in this file) or WHITELIST.txt, changes on other files are not longer conserved due to an automatic list conversion.** \ No newline at end of file +!!! danger + Please, make changes only on BLACKLIST.txt (Don't put extra lines or comments in this file) or WHITELIST.txt, changes on other files are not longer conserved due to an automatic list conversion. \ No newline at end of file diff --git a/docs/docs_faq.md b/docs/docs_faq.md index 83dec18..5e2aa5f 100644 --- a/docs/docs_faq.md +++ b/docs/docs_faq.md @@ -4,17 +4,17 @@ Here you can find some frequently asked questions and answers about our blocklis ## Why do black spaces continue to appear where the advertisements were before? -!!! question inline end "Answer" +!!! question "Answer" Although our blockoblocklist blocks banner and image ads, Spotify's apps continue to reserve a space to place these ads, and since Spotify can't get those ads and banners, they will continue to appear in black. ![Space Example](./images/ads_space.png) ## Why do I sometimes get a message "This content cannot be played at this time? -!!! question inline end "Answer" +!!! question "Answer" When Spotify tries to display an ad, it changes the name of the song to Advertisement, and attempts to load the audio and images from the ad. However, since it is unable to get this content through the blocklist, Spotify will resume playing music as normal. ## Why does Spotify sometimes take longer to load or behave strangely? -!!! question inline end "Answer" +!!! question "Answer" Although this list is safe and cannot damage your Spotify or your computer in any way. Sometimes Spotify may take a little bit longer to load or have some weird behavior, because the application is actually trying to continuously contact some ad domains, tracking, which are usually constantly changing to find unblocked domains. And this can sometimes change the behavior of the application a little bit. \ No newline at end of file diff --git a/docs/docs_installation.md b/docs/docs_installation.md index 5a2168a..592d5bb 100644 --- a/docs/docs_installation.md +++ b/docs/docs_installation.md @@ -11,11 +11,11 @@ To install Spotify Ads List you can follow this steps: Spotify Ads List is compatible with all major ad blockers, both open-source and paid. The currently supported adblockers are: -- Standard (Compatible with multiple adblockers and can also be used with the hosts file.) -- [Pi-Hole](https://pi-hole.net) -- [Dnsmasq](https://dnsmasq.org/doc.html) -- [Adguard](https://adguard.com/es/welcome.html) -- [uBlock Origin](https://ublockorigin.com) +* Standard (Compatible with multiple adblockers and can also be used with the hosts file.) +* [Pi-Hole](https://pi-hole.net) +* [Dnsmasq](https://dnsmasq.org/doc.html) +* [Adguard](https://adguard.com/es/welcome.html) +* [uBlock Origin](https://ublockorigin.com) !!! tip Being a simple and very backward compatible list, if your adblocker is not included above, you can ask us to include it and if necessary to generate a custom list layout for it. @@ -47,18 +47,18 @@ Also, you must have installed Spotify (in case you are going to use it as an app Below, you can find a series of basic guides on how to install and use your adblocker: -- Standard (Compatible with multiple adblockers and can also be used with the hosts file.) -- [Pi-Hole](https://docs.pi-hole.net/main/basic-install/) -- [Dnsmasq](https://dnsmasq.org/doc.html) -- [Adguard](https://adguard.com/kb/general/how-to-install/) -- [uBlock Origin](https://github.com/gorhill/uBlock?tab=readme-ov-file#installation) +* Standard (Compatible with multiple adblockers and can also be used with the hosts file.) +* [Pi-Hole](https://docs.pi-hole.net/main/basic-install/) +* [Dnsmasq](https://dnsmasq.org/doc.html) +* [Adguard](https://adguard.com/kb/general/how-to-install/) +* [uBlock Origin](https://github.com/gorhill/uBlock?tab=readme-ov-file#installation) ### Setup Spotify To start using Spotify you can use the web app or download the app for your OS: -- [Spotify Web App](https://open.spotify.com) -- [Download Spotify](https://www.spotify.com/en/download/) +* [Spotify Web App](https://open.spotify.com) +* [Download Spotify](https://www.spotify.com/en/download/) ## 4. Add Spotify Ads List to your adblocker @@ -73,7 +73,7 @@ To add Spotify Ads List to your adblocker you will need to make use of a raw fil | Dnsmasq | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/dnsmasq.txt | | Adguard | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/adguard.txt | -!!! question inline end "How can I do this?" +!!! question "How can I do this?" You can find more help about how to add this on this links: | Adblocker | Link | @@ -99,7 +99,7 @@ To add Spotify Ads List to your adblocker you will need to make use of a raw fil To add the whitelist to your adblocker, you have to enter the whitelist domains manually in the whitelist area. You can found the whitelist on this [link](./docs_whitelist.md) -!!! question inline end "How can I do this?" +!!! question "How can I do this?" You can find more help about how to add this on this links: | Adblocker | Link | @@ -117,7 +117,7 @@ To add the whitelist to your adblocker, you have to enter the whitelist domains Now the installation of the list should be complete, but you can still do more things: -- [Support my work by giving a star to my repository and/or creating a fork on GitHub](https://github.com/Isaaker/Spotify-AdsList) -- [Continue reading the documentation](spotify.piscinadeentropia.es) -- [Report false positives or contribute in our repository](https://github.com/Isaaker/Spotify-AdsList/issues) -- [Add more adlists](./why_add_more_blocklists) \ No newline at end of file +* [Support my work by giving a star to my repository and/or creating a fork on GitHub](https://github.com/Isaaker/Spotify-AdsList) +* [Continue reading the documentation](spotify.piscinadeentropia.es) +* [Report false positives or contribute in our repository](https://github.com/Isaaker/Spotify-AdsList/issues) +* [Add more adlists](./why_add_more_blocklists) \ No newline at end of file diff --git a/docs/images/contributing.svg b/docs/images/contributing.svg new file mode 100644 index 0000000..6c2d304 --- /dev/null +++ b/docs/images/contributing.svg @@ -0,0 +1,18 @@ + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/images/standard_logo.svg b/docs/images/standard_logo.svg new file mode 100644 index 0000000..943b320 --- /dev/null +++ b/docs/images/standard_logo.svg @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff --git a/docs/versions_standard.md b/docs/versions_standard.md new file mode 100644 index 0000000..fd16f45 --- /dev/null +++ b/docs/versions_standard.md @@ -0,0 +1,17 @@ +# Standard Version + +![Standard version logo](./images/standard_logo.svg) + +## About + +The Standard format is a highly compatible format. Although this format may not adapt perfectly to the syntax of your adblocker, you can use it with your adblocker while creating a version more adapted to your adblocker. + +In addition, it is possible to use it with the hosts file of your device as described in [this blog](https://nordvpn.com/es/blog/use-hosts-file-block-ads-malware/). + +## Files + +You can see here the version files: + +| Name | Compatibility | Raw URL | File | +| -- | -- | -- | -- | +| Standard | Highly compatible, no particular system | https://raw.githubusercontent.com/Isaaker/Spotify-AdsList/main/Lists/standard_list.txt | https://github.com/Isaaker/Spotify-AdsList/blob/main/Lists/standard_list.txt \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index e1e74e7..85f4332 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -54,7 +54,7 @@ nav: - "Pi-Hole": "docs_pihole.md" - "Dnsmasq": "docs_dnsmasq.md" - "Adguard": "docs_adguard.md" - - Whitelist: docs_whitelist.md + - "Whitelist": "docs_whitelist.md" - Testing: docs_testing.md - Docs: - "F.A.Q": "docs_faq.md" @@ -64,7 +64,7 @@ nav: - About: - "About": docs_about.md - "License": docs_license.md - - "Contributing.md": docs_contributing.md + - "Contributing": docs_contributing.md - Report Bug: https://github.com/Isaaker/Spotify-AdsList/issues extra: social: From ebfb004fb460a79c101c9be481ba4373f6cf18d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isaac=20Hern=C3=A1n?= <77550577+Isaaker@users.noreply.github.com> Date: Tue, 9 Jul 2024 10:01:09 +0200 Subject: [PATCH 13/16] Create label.yml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Isaac Hernán <77550577+Isaaker@users.noreply.github.com> --- .github/workflows/label.yml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/workflows/label.yml diff --git a/.github/workflows/label.yml b/.github/workflows/label.yml new file mode 100644 index 0000000..4613569 --- /dev/null +++ b/.github/workflows/label.yml @@ -0,0 +1,22 @@ +# This workflow will triage pull requests and apply a label based on the +# paths that are modified in the pull request. +# +# To use this workflow, you will need to set up a .github/labeler.yml +# file with configuration. For more information, see: +# https://github.com/actions/labeler + +name: Labeler +on: [pull_request_target] + +jobs: + label: + + runs-on: ubuntu-latest + permissions: + contents: read + pull-requests: write + + steps: + - uses: actions/labeler@v4 + with: + repo-token: "${{ secrets.GITHUB_TOKEN }}" From fd573b0ebff7f2ac9a4f4207fa10f0bb739e5f0e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isaac=20Hern=C3=A1n?= <77550577+Isaaker@users.noreply.github.com> Date: Tue, 9 Jul 2024 10:43:00 +0200 Subject: [PATCH 14/16] Create labeler.yml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Isaac Hernán <77550577+Isaaker@users.noreply.github.com> --- .github/labeler.yml | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .github/labeler.yml diff --git a/.github/labeler.yml b/.github/labeler.yml new file mode 100644 index 0000000..7f3f832 --- /dev/null +++ b/.github/labeler.yml @@ -0,0 +1,6 @@ +Blocklists: +- any: ['Lists/BLACKLIST.txt', 'Lists/adguard.txt', 'Lists/dnsmasq.txt', 'Lists/pi-hole.txt', 'Lists/standard_list.txt'] +Whitelist: +- any: ['Lists/WHITELIST.txt'] +documentation: +- any: ['docs/*'] From 3451144b053f63ffc51fd59729cb8d8532e73bfd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isaac=20Hern=C3=A1n?= <77550577+Isaaker@users.noreply.github.com> Date: Tue, 9 Jul 2024 10:46:43 +0200 Subject: [PATCH 15/16] Update sast-semgrep.yml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Isaac Hernán <77550577+Isaaker@users.noreply.github.com> --- .github/workflows/sast-semgrep.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/sast-semgrep.yml b/.github/workflows/sast-semgrep.yml index e4e4427..9f44158 100644 --- a/.github/workflows/sast-semgrep.yml +++ b/.github/workflows/sast-semgrep.yml @@ -1,5 +1,7 @@ name: SAST Semgrep on: + pull_request: {} + push: {} workflow_dispatch: jobs: sast_semgrep: @@ -7,4 +9,4 @@ jobs: contents: read uses: ramshackle-code/sast_semgrep/.github/workflows/sast_semgrep.yml@17a2b599ce6930240aa6c2797eb121c8fe5badf4 #v1.0.2 secrets: - token: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file + token: ${{ secrets.GITHUB_TOKEN }} From 78a3f04170a684a0f77b8682a22135f9a516baa2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isaac=20Hern=C3=A1n?= <77550577+Isaaker@users.noreply.github.com> Date: Fri, 12 Jul 2024 11:42:04 +0200 Subject: [PATCH 16/16] Update pull_request_template.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Isaac Hernán <77550577+Isaaker@users.noreply.github.com> --- .../pull_request_template.md | 27 ++++++++++++++----- 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index a3ab055..f42318f 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -1,11 +1,26 @@ +# About + +Tell us more about your PR + +# Issues + +We worked in the following issues on the Pull Request: +* #EXAMPLE + +# Requirements Please check these requirements: **pull requests that do not meet these requirements will not be accepted under any circumstances** -- [ ] The content I want to contribute is appropriate ([Read more](https://github.com/Isaaker/piscinadeentropia/blob/main/CONTRIBUTING.md)) -- [ ] I agree that my contributions are licensed and I accept the [terms and conditions of the license](https://github.com/Isaaker/piscinadeentropia/blob/main/LICENSE.txt) -- [ ] I accept the [code of conduct](https://github.com/Isaaker/piscinadeentropia/blob/main/CODE_OF_CONDUCT) -- [ ] I read the documentation on [how to contribute](https://github.com/Isaaker/piscinadeentropia/blob/main/CONTRIBUTING.md) +- [ ] The content I want to contribute is appropriate ([Read more](https://spotify.piscinadeentropia.es/docs_contributing/#content-to-collaborate-with)) +- [ ] I agree that my contributions are licensed and I accept the [terms and conditions of the license](https://spotify.piscinadeentropia.es/docs_license/) +- [ ] I accept the [code of conduct](https://github.com/Isaaker/Spotify-AdsList/blob/main/CODE_OF_CONDUCT.md) +- [ ] I read the documentation on [how to contribute](https://spotify.piscinadeentropia.es/docs_contributing/) - [ ] I have checked that the pull is not being performed against main +- [ ] I agree to be listed as a contributor of the repository. [Learn more...](https://spotify.piscinadeentropia.es/docs_contributing/#appear-as-a-contributor) -* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...) +# Co-Authored -* **Other information**: (Closes # xxx ) \ No newline at end of file +List the people who contributed to your PR, otherwise leave blank. + +# More information + +If you want more information about this pull request, don't be afraid of [opening a new issue with the label "question"](https://github.com/Isaaker/Spotify-AdsList/issues/new?assignees=isaaker&labels=question) or asking here (if the PR is still open).