-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #23 from Isaaker/Developer
Add new docs and work one some Issues
- Loading branch information
Showing
29 changed files
with
3,562 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| name: New List Format Request | ||
| description: Request a new file format for you adblocker | ||
| title: "New file format request - <ADBLOCKER>" | ||
| labels: ["Enhancement", "Blocklists"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thank you for creating this issue, please tell us more. | ||
| - type: input | ||
| id: contact | ||
| attributes: | ||
| label: Contact Details | ||
| description: How can we get in touch with you if we need more info? | ||
| placeholder: Example -> email@example.com | ||
| validations: | ||
| required: false | ||
| - type: input | ||
| id: adblocker | ||
| attributes: | ||
| label: What is the name of your adblocker? | ||
| description: Please, enter the name of tyour adblocker | ||
| placeholder: Example -> Pi-Hole | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: | ||
| attributes: | ||
| label: What is the name of your adblocker? | ||
| description: Please, enter the name of tyour adblocker | ||
| placeholder: Example -> Pi-Hole | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: | ||
| attributes: | ||
| label: Please, provide the URL to the adblocker official web | ||
| description: Please, enter the URL of the official web page of the adblocker | ||
| placeholder: Example -> pi-hole.net | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: | ||
| attributes: | ||
| label: Please, provide the URL to the adblocker documentation | ||
| description: Please, enter the URL of the official adblocker documentation | ||
| placeholder: Example -> docs.pi-hole.net | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: format_example | ||
| attributes: | ||
| label: Format Example | ||
| description: If you have a example list of the adblocker format, you can put it here. | ||
| render: shell | ||
| - type: textarea | ||
| id: extra-info | ||
| attributes: | ||
| label: Extra Info about the request | ||
| description: Tell us extra info about the request | ||
| - type: checkboxes | ||
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Isaaker/Ghost_Simulator_ES/blob/main/CODE_OF_CONDUCT.md) | ||
| options: | ||
| - label: I agree to follow this project's Code of Conduct | ||
| required: true | ||
| - label: I read the avaible Documentation | ||
| required: true | ||
| - label: I have checked that there is no issue on the same subject | ||
| required: true | ||
| - label: I have checked that my issue does not contain any relevant security data (Passwords, Secrets or Users) | ||
| required: true | ||
| - label: I have checked that my issue is not a Security Vulneability. Please, read Security Policy. | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # To get started with Dependabot version updates, you'll need to specify which | ||
| # package ecosystems to update and where the package manifests are located. | ||
| # Please see the documentation for all configuration options: | ||
| # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates | ||
|
|
||
| version: 2 | ||
| updates: | ||
| - package-ecosystem: "pip" # See documentation for possible values | ||
| directory: "/requirements.txt" # Location of package manifests | ||
| schedule: | ||
| interval: "weekly" | ||
| - package-ecosystem: "github-actions" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "weekly" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| name: MkDocs Deploy | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - 'docs/**' | ||
| - 'mkdocs.yml' | ||
|
|
||
| jobs: | ||
| linters: | ||
| name: Repository linters | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Check out the code | ||
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # @v4.1.7 | ||
| - name: Install NodeJs # Install Software NodeJs | ||
| uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # @v4.0.2 | ||
| with: | ||
| node-version: 16 | ||
| - name: Install repo-linter | ||
| run: | | ||
| npm install -g repolinter | ||
| - name: Run Repo Linter | ||
| run: | | ||
| repolinter --rulesetFile cfg/repolint.json lint . | ||
| scan: | ||
| name: gitleaks | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 | ||
| with: | ||
| fetch-depth: 0 | ||
| - uses: gitleaks/gitleaks-action@44c470ffc35caa8b1eb3e8012ca53c2f9bea4eb5 | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| GITLEAKS_CONFIG: cfg/gitleaks.toml | ||
|
|
||
| build: | ||
| name: MkDocs Github Pages automatic deployment | ||
| runs-on: ubuntu-latest | ||
| needs: | ||
| - linters | ||
| - scan | ||
| steps: | ||
| - name: Checkout main | ||
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 | ||
|
|
||
| - name: Set up Python 3.9 | ||
| uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d | ||
| with: | ||
| python-version: '3.9' | ||
|
|
||
| - name: Install requirements | ||
| run: | | ||
| python -m pip install --upgrade pip | ||
| pip install -r requirements.txt | ||
| - name: MkDocs gh-deploy | ||
| run: | | ||
| git pull | ||
| mkdocs gh-deploy -v |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # Action to Lint open repositories for common issues | ||
| # Uses https://github.com/todogroup/repolinter | ||
|
|
||
| # Needs master/repolint.json | ||
|
|
||
| name: Repository Linter | ||
| on: | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| launch-repolint: | ||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.ref }} # Only 1 instance at time | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Check out the code | ||
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # @v4.1.7 | ||
|
|
||
| - name: Install NodeJs # Install Software NodeJs | ||
| uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # @v4.0.2 | ||
| with: | ||
| node-version: 16 | ||
|
|
||
| - name: Install repo-linter | ||
| run: | | ||
| npm install -g repolinter | ||
| - name: Run Repo Linter | ||
| run: | | ||
| repolinter --rulesetFile cfg/repolint.json lint . |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| # Empty |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.