Skip to content

Commit 27dd3a7

Browse files
redeboerredeboer
committed
FEAT: convert _relink_references.py to module
1 parent 3269eb5 commit 27dd3a7

22 files changed

+991
-0
lines changed

‎.cspell.json‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
{
2+
"version": "0.2",
3+
"enableFiletypes": [
4+
"git-commit",
5+
"github-actions-workflow",
6+
"julia",
7+
"jupyter"
8+
],
9+
"flagWords": [
10+
"analyse",
11+
"colour",
12+
"comparision",
13+
"favour",
14+
"flavour",
15+
"hte",
16+
"optimise",
17+
"paramater",
18+
"parmater",
19+
"transision",
20+
"transisions"
21+
],
22+
"ignorePaths": [
23+
"**/.cspell.json",
24+
".editorconfig",
25+
".gitignore",
26+
".pre-commit-config.yaml",
27+
".prettierignore",
28+
".vscode/*",
29+
"pyproject.toml"
30+
],
31+
"language": "en-US",
32+
"words": [
33+
"autoapi",
34+
"autodoc",
35+
"ComPWA",
36+
"conda",
37+
"mypy",
38+
"PYTHONHASHSEED",
39+
"SymPy"
40+
],
41+
"ignoreWords": [
42+
"PyPI",
43+
"commitlint",
44+
"prereleased",
45+
"refdomain",
46+
"refspecific",
47+
"reftarget",
48+
"reftype",
49+
"rtfd"
50+
]
51+
}

‎.editorconfig‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
root = true
2+
3+
[*]
4+
end_of_line = lf
5+
indent_size = 2
6+
indent_style = space
7+
insert_final_newline = true
8+
trim_trailing_whitespace = true
9+
10+
[*.ipynb]
11+
indent_size = unset
12+
13+
[*.{py,toml}]
14+
indent_size = 4
15+
16+
[LICENSE]
17+
indent_size = unset
18+
19+
[setup.cfg]
20+
indent_size = 4

‎.github/release-drafter.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name-template: sphinx-api-relink $NEXT_PATCH_VERSION
2+
tag-template: $NEXT_PATCH_VERSION
3+
4+
references:
5+
- main
6+
- epic/*
7+
8+
categories:
9+
- title: ✨ New features
10+
label: ✨ Feature
11+
- title: ⚠️ Enhancements and optimizations
12+
label: ⚙️ Enhancement
13+
- title: ⚠️ API changes
14+
label: ⚠️ Interface
15+
- title: ⚠️ Changes that may affect behavior
16+
label: ❗ Behavior
17+
- title: 🐛 Bug fixes
18+
label: 🐛 Bug
19+
- title: 📝 Documentation
20+
label: 📝 Docs
21+
- title: 🔨 Maintenance
22+
label: 🔨 Maintenance
23+
- title: 🖱️ Developer Experience
24+
label: 🖱️ DX
25+
26+
change-template: "- $TITLE (#$NUMBER)"
27+
28+
replacers:
29+
- search: /([A-Z]+!?:\s*)(.*)/g
30+
replace: $2
31+
32+
sort-direction: ascending
33+
34+
template: |
35+
$CHANGES
36+
37+
_The full changelog as commits can be found [here](https://github.com/ComPWA/sphinx-api-relink/compare/$PREVIOUS_TAG...$NEXT_PATCH_VERSION)._

‎.github/workflows/cd.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: CD
2+
3+
on:
4+
release:
5+
types:
6+
- prereleased
7+
- released
8+
9+
jobs:
10+
milestone:
11+
if: startsWith(github.ref, 'refs/tags')
12+
uses: ComPWA/actions/.github/workflows/close-milestone.yml@v1
13+
pypi:
14+
if: startsWith(github.ref, 'refs/tags')
15+
secrets: inherit
16+
uses: ComPWA/actions/.github/workflows/publish-to-pypi.yml@v1
17+
push:
18+
if: startsWith(github.ref, 'refs/tags') && !github.event.release.prerelease
19+
secrets: inherit
20+
uses: ComPWA/actions/.github/workflows/push-to-version-branches.yml@v1

‎.github/workflows/ci.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: CI
2+
3+
concurrency:
4+
group: ${{ github.workflow }}-${{ github.ref }}
5+
cancel-in-progress: true
6+
7+
env:
8+
PYTHONHASHSEED: "0"
9+
10+
on:
11+
push:
12+
branches:
13+
- main
14+
- epic/*
15+
- "[0-9]+.[0-9]+.x"
16+
pull_request:
17+
branches:
18+
- main
19+
- epic/*
20+
- "[0-9]+.[0-9]+.x"
21+
workflow_dispatch:
22+
inputs:
23+
specific-pip-packages:
24+
description: Run CI with specific pip packages
25+
required: false
26+
type: string
27+
28+
jobs:
29+
style:
30+
if: inputs.specific-pip-packages == ''
31+
secrets:
32+
token: ${{ secrets.PAT }}
33+
uses: ComPWA/actions/.github/workflows/pre-commit.yml@v1

‎.github/workflows/clean-caches.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Clean caches
2+
3+
on:
4+
pull_request:
5+
types:
6+
- closed
7+
workflow_dispatch:
8+
inputs:
9+
ref:
10+
description: Clean caches for this branch name or ref
11+
required: false
12+
type: string
13+
14+
jobs:
15+
cleanup:
16+
name: Remove caches
17+
runs-on: ubuntu-22.04
18+
steps:
19+
- uses: ComPWA/actions/clean-caches@v1
20+
with:
21+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
22+
ref: ${{ inputs.ref }}

‎.github/workflows/pr-linting.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: PR linting
2+
on:
3+
pull_request:
4+
types:
5+
- edited
6+
- labeled
7+
- opened
8+
- reopened
9+
- synchronize
10+
- unlabeled
11+
12+
jobs:
13+
check-labels:
14+
name: Check labels
15+
runs-on: ubuntu-22.04
16+
steps:
17+
- uses: docker://agilepathway/pull-request-label-checker:latest # cspell:ignore agilepathway
18+
with:
19+
any_of: >-
20+
🐛 Bug,✨ Feature,⚙️ Enhancement,⚠️ Interface,❗ Behavior,📝 Docs,🔨 Maintenance,🖱️ DX
21+
none_of: Epic,💫 Good first issue
22+
repo_token: ${{ secrets.GITHUB_TOKEN }}
23+
24+
check-title:
25+
name: Check title
26+
runs-on: ubuntu-22.04
27+
steps:
28+
- uses: actions/checkout@v4
29+
- run: npm install @compwa/commitlint-config
30+
- name: Create commitlint config
31+
run: |
32+
echo "module.exports = {extends: ['@compwa/commitlint-config']}" > commitlint.config.js
33+
- uses: JulienKode/[email protected] # cspell:ignore kode

‎.github/workflows/release-drafter.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Release Drafter
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- epic/*
8+
workflow_dispatch:
9+
10+
jobs:
11+
update_release_draft:
12+
runs-on: ubuntu-22.04
13+
steps:
14+
- uses: release-drafter/release-drafter@v5
15+
env:
16+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.gitignore‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
/Jamroot
2+
3+
# Output files
4+
*.gv
5+
*.json
6+
*.npy
7+
*.out
8+
*.pdf
9+
*.pickle
10+
*.png
11+
*.root
12+
*.svg
13+
*.v2
14+
*.xml
15+
*.yaml
16+
*.yml
17+
18+
# Temporary files
19+
.fuse_hidden*
20+
.ipynb_checkpoints/
21+
__pycache__/
22+
23+
# Build files
24+
*.egg-info/
25+
*build/
26+
.eggs/
27+
.fuse_*
28+
dist/
29+
version.py
30+
31+
# Temporary files
32+
*.pyc
33+
*condaenv.*
34+
.coverage
35+
.coverage.*
36+
.ipynb_checkpoints/
37+
.mypy*/
38+
.pytest_cache/
39+
__pycache__/
40+
htmlcov/
41+
prof/
42+
43+
# Virtual environments
44+
*venv/
45+
.tox/
46+
pyvenv*/
47+
48+
# Settings
49+
.idea/
50+
**.code-workspace
51+
52+
# Exceptions
53+
!.clang-format
54+
!.cspell.json
55+
!.github/*.yml
56+
!.github/*/*.yml
57+
!.gitpod.yml
58+
!.pre-commit-config.yaml
59+
!.readthedocs.yml
60+
!.vscode/*.json
61+
!codecov.yml
62+
!environment.yml
63+
!pyrightconfig.json

0 commit comments

Comments
 (0)