Skip to content

Commit

Permalink
add github workflows, templates, funding and security files
Browse files Browse the repository at this point in the history
  • Loading branch information
Elnaril committed Dec 26, 2023
1 parent d323a26 commit 1d2156a
Show file tree
Hide file tree
Showing 6 changed files with 208 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -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"]
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/issue-and-bug-report.md
Original file line number Diff line number Diff line change
@@ -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.
15 changes: 15 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -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
47 changes: 47 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -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
98 changes: 98 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -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}}"

0 comments on commit 1d2156a

Please sign in to comment.