Skip to content

Commit 49fce14

Browse files
sjperkinssjperkins
authored
Setup GitHub Actions and pre-commit hooks (#8)
1 parent 72d4fa4 commit 49fce14

15 files changed

Lines changed: 213 additions & 49 deletions

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
- saopicc-schema version:
2+
- Python version:
3+
- Operating System:
4+
5+
### Description
6+
7+
Describe what you were trying to accomplish.
8+
Tell us what happened, what went wrong, and what you expected to happen.
9+
10+
### Reproducer and Error Logs
11+
12+
```
13+
Paste the command(s) you ran and the output.
14+
If there was a crash, please include the traceback here.
15+
```

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!--
2+
Consider opening an enhancement issue
3+
if the change is large or complex.
4+
https://github.com/saopicc/saopicc-schemas/issues/new/choose
5+
6+
Development setup information is available at the following url:
7+
https://saopicc-schemas.readthedocs.io/en/latest/
8+
-->
9+
10+
Thanks for contributing to saopicc-schemas.
11+
12+
We would appreciate it if you could add:
13+
14+
- [ ] Test Cases covering your PR.
15+
- [ ] Documentation.
16+
- [ ] A Changelog entry in `docs/source/changelog.rst`.

‎.github/dependabot.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: "github-actions" # See documentation for possible values
9+
directory: "/" # Location of package manifests
10+
schedule:
11+
interval: "weekly"

‎.github/workflows/ci.yml‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
name: Continuous Integration
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
tags:
8+
- "*"
9+
pull_request:
10+
schedule:
11+
- cron: '30 2 * * 1,4' # Every Monday and Thursday @ 2h30am UTC
12+
13+
jobs:
14+
test:
15+
runs-on: ubuntu-latest
16+
if: "!contains(github.event.head_commit.message, '[skip ci]')"
17+
strategy:
18+
fail-fast: false
19+
matrix:
20+
os: ["ubuntu-22.04"]
21+
python-version: ["3.11", "3.12", "3.13"]
22+
23+
steps:
24+
- name: Set up Python ${{ matrix.python-version }}
25+
uses: actions/setup-python@v6
26+
with:
27+
python-version: ${{ matrix.python-version }}
28+
29+
- name: Checkout source
30+
uses: actions/checkout@v5
31+
with:
32+
fetch-depth: 1
33+
34+
- name: Create virtual environment
35+
run: |
36+
python -m venv .venv
37+
source .venv/bin/activate
38+
pip install -U pip
39+
40+
- name: Install saopicc-schemas
41+
run: |
42+
source .venv/bin/activate
43+
pip install .[testing]
44+
45+
- name: Test saopicc-schemas
46+
run: |
47+
source .venv/bin/activate
48+
py.test -s -vvv tests/ -Werror
49+
50+
# - name: Debug with tmate on failure
51+
# if: ${{ failure() }}
52+
# uses: mxschmitt/action-tmate@v3
53+
54+
deploy:
55+
needs: [test]
56+
runs-on: ubuntu-latest
57+
environment:
58+
name: pypi
59+
url: https:/pypi.org/p/saopicc-schemas
60+
permissions:
61+
id-token: write
62+
steps:
63+
- name: Set up Python 3.12
64+
uses: actions/setup-python@v6
65+
with:
66+
python-version: 3.12
67+
68+
- name: Checkout source
69+
uses: actions/checkout@v5
70+
with:
71+
fetch-depth: 1
72+
73+
- name: Build distributions
74+
run: |
75+
pip install -U pip build
76+
python -m build --sdist --wheel
77+
78+
- name: Publish distribution 📦 to PyPI
79+
if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
80+
uses: pypa/gh-action-pypi-publish@release/v1

‎.github/workflows/pre-commit.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: pre-commit
2+
3+
on: [push]
4+
5+
jobs:
6+
pre-commit:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v5
10+
with:
11+
fetch-depth: 1
12+
- uses: actions/setup-python@v6
13+
with:
14+
python-version: 3.12
15+
- uses: pre-commit/action@v3.0.1

‎.gitignore‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,9 +182,9 @@ cython_debug/
182182
.abstra/
183183

184184
# Visual Studio Code
185-
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
185+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
186186
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
187-
# and can be added to the global gitignore or merged into this file. However, if you prefer,
187+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
188188
# you could uncomment the following to ignore the entire vscode folder
189189
# .vscode/
190190

‎.pre-commit-config.yaml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# See https://pre-commit.com for more information
2+
# See https://pre-commit.com/hooks.html for more hooks
3+
repos:
4+
- repo: https://github.com/pre-commit/pre-commit-hooks
5+
rev: v5.0.0
6+
hooks:
7+
- id: trailing-whitespace
8+
- id: end-of-file-fixer
9+
- id: check-yaml
10+
- id: check-added-large-files
11+
- repo: https://github.com/astral-sh/ruff-pre-commit
12+
rev: v0.14.2
13+
hooks:
14+
- id: ruff-check
15+
# Handle imports, see
16+
# https://github.com/astral-sh/ruff/issues/8232
17+
# https://github.com/astral-sh/ruff/issues/10882
18+
args: [ --fix, --extend-select, I ]
19+
- id: ruff-format
20+
name: ruff format
21+
- repo: https://github.com/pre-commit/mirrors-mypy
22+
rev: v1.17.0
23+
hooks:
24+
- id: mypy
25+
name: mypy
26+
additional_dependencies: [types-requests]

‎docs/source/changelog.rst‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,8 @@ Changelog
66

77
X.Y.Z (DD-MM-YYYY)
88
------------------
9+
* Add github actions (:pr:`8`)
10+
* Add github issue and pr templates (:pr:`8`)
11+
* Add pre-commit hooks (:pr:`8`)
912
* Add meeting minutes outline (:pr:`4`)
10-
* Add a readthedocs outline and build (:pr:`1`, :pr:`3`)
13+
* Add a readthedocs outline and build (:pr:`1`, :pr:`3`)

‎docs/source/conf.py‎

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
# -- Project information -----------------------------------------------------
77
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
88

9-
project = 'saopicc-schemas'
10-
copyright = '2025, SARAO and Observatoire de Paris'
11-
author = 'Simon Perkins'
9+
project = "saopicc-schemas"
10+
copyright = "2025, SARAO and Observatoire de Paris"
11+
author = "Simon Perkins"
1212

1313
# -- General configuration ---------------------------------------------------
1414
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -50,11 +50,6 @@
5050

5151
html_theme = "pydata_sphinx_theme"
5252

53-
# Disable navigation sidebars
54-
# https://github.com/pydata/pydata-sphinx-theme/issues/1662
55-
html_sidebars = {
56-
"**": [],
57-
}
5853
html_static_path = ["_static"]
5954

6055
extlinks = {

‎docs/source/index.rst‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,3 @@ used in the SAOPICC collaboration
1717
introduction
1818
minutes
1919
changelog
20-

0 commit comments

Comments
 (0)