From 1d2156a92fd013ce9b4559e83ffe6ae095546a67 Mon Sep 17 00:00:00 2001 From: Elnaril Date: Tue, 26 Dec 2023 18:37:15 +0100 Subject: [PATCH] add github workflows, templates, funding and security files --- .github/FUNDING.yml | 4 + .github/ISSUE_TEMPLATE/feature_request.md | 12 +++ .../ISSUE_TEMPLATE/issue-and-bug-report.md | 32 ++++++ .github/SECURITY.md | 15 +++ .github/workflows/ci.yml | 47 +++++++++ .github/workflows/codeql.yml | 98 +++++++++++++++++++ 6 files changed, 208 insertions(+) create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/issue-and-bug-report.md create mode 100644 .github/SECURITY.md create mode 100644 .github/workflows/ci.yml create mode 100644 .github/workflows/codeql.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..6033420 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,4 @@ +# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository + +github: Elnaril +custom: ["https://www.buymeacoffee.com/elnaril", "https://www.fiverr.com/freelancers/elnaril"] diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bf10c97 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,12 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' + +--- + +**Describe the feature you'd like** +- clear and concise description of the feature you'd like to see in this lib. +- use case description with example + any context +- description of any alternative you use at the moment diff --git a/.github/ISSUE_TEMPLATE/issue-and-bug-report.md b/.github/ISSUE_TEMPLATE/issue-and-bug-report.md new file mode 100644 index 0000000..d95af54 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue-and-bug-report.md @@ -0,0 +1,32 @@ +--- +name: Issue and bug report +about: Create a report to help us improve +title: '' +labels: '' + +--- + +**Check existing issues and bugs (open and closed)** +Sometime issue titles are misleading: search by keywords and check the questions/reports and answers to be sure yours has not yet been addressed. + +**Describe the issue or bug** +A clear and concise description of what the issue or bug is. + +**Formatting** +/!\ If you paste/write some code, make sure it is correctly formatted. +If relevant, consider formatting any output for better readability. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Version** +Check you're having the issue with the latest version of the lib. + +**How to reproduce** +Steps to reproduce the behavior. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..0375f55 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,15 @@ +# Security Policy + +## Supported Version +Only the latest version of this library is supported. + +## Scope +Only [vulnerabilities](https://csrc.nist.gov/glossary/term/Software_Vulnerability) in dependencies or in the library itself that can be exploited by using this library are in the scope. + +For other bugs in this library, consider opening an issue [here](https://github.com/Elnaril/python-uniswapx-sdk/issues) + +## Reporting a vulnerability +Please click on the "Report a vulnerability" button. +In the report, please include all details necessary to reproduce it, such as: + - dependency versions + - OS name and version diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..87eece3 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,47 @@ +name: Continous Integration + +on: + push: + paths-ignore: + - '.github/**' + - 'integration_tests/**' + - 'tutorials/**' + - 'README.md' + - 'LICENSE' + - '.gitignore' + - 'coverage.json' + pull_request: + paths-ignore: + - '.github/**' + - 'integration_tests/**' + - 'tutorials/**' + - 'README.md' + - 'LICENSE' + - '.gitignore' + - 'coverage.json' + +jobs: + build: + + runs-on: ${{ matrix.os }} + strategy: + fail-fast: false + matrix: + os: [ubuntu-latest] + python-version: ["3.8", "3.9", "3.10", "3.11"] + + environment: + name: CI + + steps: + - uses: actions/checkout@v3 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + - name: Install tox and any other packages + run: pip install tox + - name: Run tox + run: | + export RPC_ENDPOINT=${{ secrets.RPC_ENDPOINT }} + tox diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 0000000..92b406b --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,98 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL" + +on: + push: + branches: [ "master" ] + paths-ignore: + - '.github/**' + - 'integration_tests/**' + - 'tutorials/**' + - 'README.md' + - 'LICENSE' + - '.gitignore' + - 'coverage.json' + pull_request: + # The branches below must be a subset of the branches above + branches: [ "master" ] + paths-ignore: + - '.github/**' + - 'integration_tests/**' + - 'tutorials/**' + - 'README.md' + - 'LICENSE' + - '.gitignore' + - 'coverage.json' + schedule: + - cron: '17 18 * * 5' + +jobs: + analyze: + name: Analyze + # Runner size impacts CodeQL analysis time. To learn more, please see: + # - https://gh.io/recommended-hardware-resources-for-running-codeql + # - https://gh.io/supported-runners-and-hardware-resources + # - https://gh.io/using-larger-runners + # Consider using larger runners for possible analysis time improvements. + runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }} + timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }} + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: [ 'python' ] + # CodeQL supports [ 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift' ] + # Use only 'java-kotlin' to analyze code written in Java, Kotlin or both + # Use only 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both + # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v2 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + + # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs + # queries: security-extended,security-and-quality + + + # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v2 + + # ℹī¸ Command-line programs to run using the OS shell. + # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun + + # If the Autobuild fails above, remove it and uncomment the following three lines. + # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. + + # - run: | + # echo "Run, Build Application using script" + # ./location_of_script_within_repo/buildscript.sh + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v2 + with: + category: "/language:${{matrix.language}}"