Skip to content

Commit

Permalink
refactor: apply standard configs from TNR projects
Browse files Browse the repository at this point in the history
  • Loading branch information
linuxdaemon committed May 11, 2024
1 parent 6e49e41 commit 6e74616
Show file tree
Hide file tree
Showing 16 changed files with 691 additions and 77 deletions.
14 changes: 14 additions & 0 deletions .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
FROM mcr.microsoft.com/devcontainers/python:3.9

RUN \
pipx uninstall mypy \
&& pipx uninstall pylint \
&& pipx uninstall pytest \
&& pipx uninstall flake8 \
&& pipx uninstall black \
&& pipx install commitizen \
&& pip install -U hatch hatch-containers

RUN su vscode -c "hatch config set dirs.env.virtual /home/vscode/.virtualenvs"

ENV SHELL /bin/bash
59 changes: 59 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/python
{
"name": "Python 3",
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
"dockerFile": "./Dockerfile",
"context": "..",
"features": {
"ghcr.io/devcontainers-contrib/features/zsh-plugins": {
"omzPlugins": "https://github.com/zsh-users/zsh-autosuggestions"
},
"ghcr.io/devcontainers/features/docker-in-docker": {}
},

// Features to add to the dev container. More info: https://containers.dev/features.
// "features": {},

// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],

// Use 'postCreateCommand' to run commands after the container is created.
"postCreateCommand": "hatch run setup-dev",
// Configure tool-specific properties.
// "customizations": {},

// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "root",
"customizations": {
"vscode": {
"extensions": [
"tamasfe.even-better-toml",
"ms-python.python",
"ms-python.vscode-pylance",
"EditorConfig.EditorConfig",
"GitHub.vscode-pull-request-github",
"github.vscode-github-actions",
"redhat.vscode-yaml",
"ms-python.black-formatter",
"ms-python.isort",
"ms-azuretools.vscode-docker",
"ms-python.mypy-type-checker",
"sunipkm.autodocstringpy"
],
"settings": {
"python.defaultInterpreterPath": "~/.virtualenvs/polymatch/bin/python",
"python.testing.pytestArgs": ["--no-cov"],
"terminal.integrated.profiles.linux": {
"zsh": {
"path": "/usr/bin/zsh"
}
},
"terminal.integrated.defaultProfile.linux": "zsh",
"[python]": {
"editor.defaultFormatter": "ms-python.black-formatter"
}
}
}
}
}
4 changes: 2 additions & 2 deletions .docker/Dockerfile
100755 → 100644
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM python:3.8 AS builder
FROM python:3.9 AS builder

RUN apt-get update && \
apt-get install --no-install-recommends --no-install-suggests -y \
Expand All @@ -13,7 +13,7 @@ WORKDIR /source

RUN rm -rf dist && /root/.local/bin/hatch build -t wheel

FROM python:3.8-slim
FROM python:3.9-slim

WORKDIR /gvm-sync-targets

Expand Down
Empty file modified .docker/entrypoint.sh
100644 → 100755
Empty file.
16 changes: 16 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
version: 2
updates:
- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "daily"

- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"

- package-ecosystem: "devcontainers"
directory: /
schedule:
interval: weekly
89 changes: 89 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# 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: [ "main" ]
pull_request:
branches: [ "main" ]
schedule:
- cron: '18 15 * * 3'

jobs:
analyze:
name: Analyze (${{ matrix.language }})
# 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 (GitHub.com only)
# Consider using larger runners or machines with greater resources for possible analysis time improvements.
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
permissions:
# required for all workflows
security-events: write

# only required for workflows in private repositories
actions: read
contents: read

strategy:
fail-fast: false
matrix:
include:
- language: python
build-mode: none
# CodeQL supports the following values keywords for 'language': 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'
# Use `c-cpp` to analyze code written in C, C++ or both
# Use 'java-kotlin' to analyze code written in Java, Kotlin or both
# Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
# To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
# see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
# If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
# your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
steps:
- name: Checkout repository
uses: actions/checkout@v4

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}
build-mode: ${{ matrix.build-mode }}
# 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

# If the analyze step fails for one of the languages you are analyzing with
# "We were unable to automatically build your code", modify the matrix above
# to set the build mode to "manual" for that language. Then modify this step
# to build your code.
# ℹ️ 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: matrix.build-mode == 'manual'
run: |
echo 'If you are using a "manual" build mode for one or more of the' \
'languages you are analyzing, replace this with the commands to build' \
'your code, for example:'
echo ' make bootstrap'
echo ' make release'
exit 1
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3
with:
category: "/language:${{matrix.language}}"
Empty file modified .github/workflows/docker.yml
100755 → 100644
Empty file.
42 changes: 42 additions & 0 deletions .github/workflows/python-tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Python tests

on:
push:
branches: [main]
pull_request:
branches: [main]

jobs:
build:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version:
- '3.9'
- '3.10'
- '3.11'
- '3.12'
steps:
- uses: actions/checkout@v4

- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "${{matrix.python-version}}"
cache: "pip"

- name: Install Hatch
run: pip install --user --upgrade hatch

- name: Test with pytest
run: hatch run cov
env:
PYTHONDEVMODE: 1

- uses: codecov/codecov-action@v4
with:
name: "build-${{ matrix.python-version }}"
fail_ci_if_error: true
env:
CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}
Loading

0 comments on commit 6e74616

Please sign in to comment.