Skip to content

Commit

Permalink
Several improvements: everything hatch + github workflows and configs…
Browse files Browse the repository at this point in the history
… + license & authors
  • Loading branch information
matagus committed Feb 23, 2024
1 parent 0389d95 commit 0a7d89d
Show file tree
Hide file tree
Showing 22 changed files with 636 additions and 127 deletions.
14 changes: 14 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Code of Conduct

Everyone interacting in this project is expected to follow the
[Django's Code of Conduct](https://www.djangoproject.com/conduct/). This includes all infrastructure
used in the development of this project, such as codebase, issue tracker, chat rooms, and mailing lists.

In general, this means that everyone is expected to be **open**, **considerate**, and **respectful**
of others no matter what their position is within the project.

## Reporting

All incidents should be reported by [email protected]. This email is an alias with the following responders:

* Matias Agustin Mendez (https://github.com/matagus)
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Bug Report
description: File a bug
body:
- type: input
id: macos_version
attributes:
label: Operating System
description: Which operating system were you using?
placeholder: MacOS Sonoma 14.3
validations:
required: false
- type: input
id: package_version
attributes:
label: Package Version
description: Which version of this package were you using? If not the latest version, please check this issue has not since been resolved.
placeholder: 0.2.0
validations:
required: false
- type: input
id: python_version
attributes:
label: Python Version
description: Which version of Python were you using?
placeholder: 3.12.0
validations:
required: false
- type: textarea
id: description
attributes:
label: Description
description: Please describe the bug
validations:
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Ask a Question
url: https://github.com/matagus/matorral/discussions/new?category=q-a&title=[Question]
about: Ask questions and discuss with other community members
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Feature Request
description: Request an enhancement or new feature.
body:
- type: textarea
id: description
attributes:
label: Description
description: Please describe your feature request with appropriate detail.
validations:
required: true
1 change: 1 addition & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Please report security issues directly over email to [email protected]
6 changes: 6 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version: 2
updates:
- package-ecosystem: github-actions
directory: "/"
schedule:
interval: weekly
45 changes: 45 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: CI
on:
workflow_dispatch:
push:
branches:
- main
pull_request:
branches:
- main
env:
DJANGO_SECRET_KEY: ${{ secrets.DJANGO_SECRET_KEY }}

jobs:
test:
strategy:
max-parallel: 2
fail-fast: true
matrix:
python-version: ["3.9", "3.10", "3.11", "3.12"]
django-version: ["4.0", "4.1", "4.2"]
os: [ubuntu-latest]
exclude:
- django-version: "4.0"
python-version: "3.11"
- django-version: "4.0"
python-version: "3.12"
- django-version: "4.1"
python-version: "3.12"
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade hatch
- name: Run tests for Python ${{ matrix.python-version }} and Django ${{ matrix.django-version }} on ${{ matrix.os }} with coverage report
run: |
hatch run test.py${{ matrix.python-version }}-${{ matrix.django-version }}:cov
- name: Upload coverage reports to Codecov
uses: codecov/codecov-action@v4
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
21 changes: 21 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Create Draft Release

on:
workflow_dispatch:
push:
tags:
- "v*"

jobs:

build:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- uses: ncipollo/release-action@v1
with:
draft: true
allowUpdates: true
generateReleaseNotes: true
14 changes: 0 additions & 14 deletions .pylintrc

This file was deleted.

21 changes: 0 additions & 21 deletions .travis.yml

This file was deleted.

7 changes: 7 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Primary Authors

- Matias Agustin Mendez (https://github.com/matagus)

# Contributors

No contributions yet.
Loading

0 comments on commit 0a7d89d

Please sign in to comment.