Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .envrc
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
uv sync --all-extras --quiet
source .venv/bin/activate
layout uv --quiet
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @ComPWA/maintainers
1 change: 0 additions & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ version: 2

multi-ecosystem-groups:
lock:
assignees: [redeboer]
commit-message: { prefix: MAINT }
schedule: { interval: quarterly }

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ on:
jobs:
milestone:
if: startsWith(github.ref, 'refs/tags')
uses: ComPWA/actions/.github/workflows/close-milestone.yml@313866498eb92c341d7e6b905e09f33a5979dffb # v4.1.4
uses: ComPWA/actions/.github/workflows/close-milestone.yml@a024afbb9e182bea4924a73fc60ae59462849ebb # v4.2.0
push:
if: startsWith(github.ref, 'refs/tags') && !github.event.release.prerelease
permissions:
contents: write
uses: ComPWA/actions/.github/workflows/push-to-version-branches.yml@313866498eb92c341d7e6b905e09f33a5979dffb # v4.1.4
uses: ComPWA/actions/.github/workflows/push-to-version-branches.yml@a024afbb9e182bea4924a73fc60ae59462849ebb # v4.2.0
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ on:

jobs:
doc:
uses: ComPWA/actions/.github/workflows/ci-docs.yml@313866498eb92c341d7e6b905e09f33a5979dffb # v4.1.4
uses: ComPWA/actions/.github/workflows/ci-docs.yml@a024afbb9e182bea4924a73fc60ae59462849ebb # v4.2.0
permissions:
pages: write
id-token: write
Expand All @@ -30,4 +30,4 @@ jobs:
style:
secrets:
token: ${{ secrets.PAT }}
uses: ComPWA/actions/.github/workflows/style.yml@313866498eb92c341d7e6b905e09f33a5979dffb # v4.1.4
uses: ComPWA/actions/.github/workflows/style.yml@a024afbb9e182bea4924a73fc60ae59462849ebb # v4.2.0
2 changes: 1 addition & 1 deletion .github/workflows/clean-caches.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
name: Remove caches
runs-on: ubuntu-slim
steps:
- uses: ComPWA/actions/clean-caches@313866498eb92c341d7e6b905e09f33a5979dffb # v4.1.4
- uses: ComPWA/actions/clean-caches@a024afbb9e182bea4924a73fc60ae59462849ebb # v4.2.0
with:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
ref: ${{ inputs.ref }}
2 changes: 1 addition & 1 deletion .github/workflows/lock.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ on:

jobs:
lock:
uses: ComPWA/actions/.github/workflows/lock.yml@313866498eb92c341d7e6b905e09f33a5979dffb # v4.1.4
uses: ComPWA/actions/.github/workflows/lock.yml@a024afbb9e182bea4924a73fc60ae59462849ebb # v4.2.0
secrets:
token: ${{ secrets.PAT }}
2 changes: 1 addition & 1 deletion .github/workflows/pr-linting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ on:

jobs:
lint-pr:
uses: ComPWA/actions/.github/workflows/pr-linting.yml@313866498eb92c341d7e6b905e09f33a5979dffb # v4.1.4
uses: ComPWA/actions/.github/workflows/pr-linting.yml@a024afbb9e182bea4924a73fc60ae59462849ebb # v4.2.0
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,5 @@ GEMINI.md
!.pre-commit-config.yaml
!.readthedocs.yml
!.vscode/*.json
!.zenodo.json
!codecov.yml
.jupyter_ystore.db
.lycheecache
25 changes: 15 additions & 10 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,11 @@ repos:
- id: check-useless-excludes

- repo: https://github.com/ComPWA/policy
rev: 0.10.1
rev: 0.10.5
hooks:
- id: check-dev-files
# Policy 0.10.4 imports TyperChoice from typer.main.
additional_dependencies: ["typer<0.29"]

- repo: https://github.com/kynan/nbstripout
rev: 0.9.1
Expand Down Expand Up @@ -58,13 +60,11 @@ repos:
- id: strip-nb-whitespace

- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.17.0
rev: v0.17.4
hooks:
- id: ruff-check
args: [--fix]
types_or: [python, pyi, jupyter]
- id: ruff-format
types_or: [python, pyi, jupyter]

- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v6.0.0
Expand Down Expand Up @@ -92,19 +92,19 @@ repos:
)$

- repo: https://github.com/tombi-toml/tombi-pre-commit
rev: v1.8.2
rev: v1.11.1
hooks:
- id: tombi-format
- id: tombi-lint
args: [--error-on-warnings]

- repo: https://github.com/ComPWA/prettier-pre-commit
rev: v3.8.1
rev: v3.9.10
hooks:
- id: prettier

- repo: https://github.com/python-jsonschema/check-jsonschema
rev: 0.38.2
rev: 0.39.0
hooks:
- id: check-jsonschema
name: Check CITATION.cff
Expand All @@ -117,10 +117,15 @@ repos:
pass_filenames: false

- repo: https://github.com/streetsidesoftware/cspell-cli
rev: v10.3.0
rev: v10.4.0
hooks:
- id: cspell

- repo: https://github.com/LilSpazJoekp/docstrfmt
rev: v2.2.1
hooks:
- id: docstrfmt

- repo: https://github.com/editorconfig-checker/editorconfig-checker.python
rev: 3.11.1
hooks:
Expand All @@ -143,12 +148,12 @@ repos:
)$

- repo: https://github.com/astral-sh/ty-pre-commit
rev: v0.0.86
rev: v0.0.100
hooks:
- id: ty
args: [--group=types, --no-default-groups]

- repo: https://github.com/astral-sh/uv-pre-commit
rev: 0.13.0
rev: 0.13.7
hooks:
- id: uv-lock
20 changes: 9 additions & 11 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,14 @@ build:
os: ubuntu-24.04
tools:
python: "3.14"
commands:
- |-
export PIXI_HOME=$READTHEDOCS_VIRTUALENV_PATH
curl -fsSL https://pixi.sh/install.sh | bash
pixi global install graphviz uv
- |-
export UV_LINK_MODE=copy
uvx --from poethepoet poe doc
mkdir -p $READTHEDOCS_OUTPUT
mv docs/_build/html $READTHEDOCS_OUTPUT

apt_packages:
- graphviz
sphinx:
configuration: docs/conf.py
fail_on_warning: true
python:
install:
- method: uv
command: sync
groups:
- doc
1 change: 0 additions & 1 deletion .vscode/extensions.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
"ms-toolsai.jupyter",
"ms-toolsai.vscode-jupyter-cell-tags",
"ms-vscode.live-server",
"ms-vsliveshare.vsliveshare",
"redhat.vscode-yaml",
"simonsiefke.svg-preview",
"soulcode.vscode-unwanted-extensions",
Expand Down
18 changes: 3 additions & 15 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,9 @@
"rewrap.wrappingColumn": 72
},
"[json]": {
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.wordWrap": "on"
},
"[jsonc]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[markdown]": {
"[json][jsonc][markdown][yaml]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[python]": {
Expand All @@ -23,9 +19,6 @@
"[toml]": {
"editor.defaultFormatter": "tombi-toml.tombi"
},
"[yaml]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"cSpell.enabled": true,
"diffEditor.experimental.showMoves": true,
"editor.formatOnSave": true,
Expand All @@ -39,11 +32,10 @@
"json.schemas": [
{
"fileMatch": [".zenodo.json"],
"url": "https://zenodo.org/schemas/deposits/records/legacyrecord.json"
"url": "https://raw.githubusercontent.com/zenodo/zenodo/master/zenodo/modules/deposit/jsonschemas/deposits/records/legacyrecord.json"
}
],
"livePreview.defaultPreviewPath": "docs/_build/html",
"multiDiffEditor.experimental.enabled": true,
"notebook.codeActionsOnSave": {
"notebook.source.organizeImports": "explicit"
},
Expand All @@ -63,9 +55,5 @@
"telemetry.telemetryLevel": "off",
"ty.completions.autoImport": false,
"ty.diagnosticMode": "workspace",
"ty.importStrategy": "fromEnvironment",
"yaml.schemas": {
"https://citation-file-format.github.io/1.2.0/schema.json": "CITATION.cff",
"https://json.schemastore.org/github-workflow.json": "./.github/workflows/requirements.yml"
}
"ty.importStrategy": "fromEnvironment"
}
7 changes: 2 additions & 5 deletions docs/adr.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@

# Architectural Decision Records

This log lists the architectural decisions for the
[ComPWA Organization](https://github.com/ComPWA):
This log lists the architectural decisions for the [ComPWA Organization](https://github.com/ComPWA):

```{toctree}
---
Expand All @@ -13,6 +12,4 @@ maxdepth: 1
adr/*
```

For new ADRs, please use {download}`adr/template.md` as basis. This template was
inspired by [MADR](https://adr.github.io/madr). General information about architectural
decision records is available at [adr.github.io](https://adr.github.io).
For new ADRs, please use {download}`adr/template.md` as basis. This template was inspired by [MADR](https://adr.github.io/madr). General information about architectural decision records is available at [adr.github.io](https://adr.github.io).
24 changes: 7 additions & 17 deletions docs/adr/000.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,25 @@ Status: **accepted**

Deciders: @redeboer, @spflueger

Technical story: A large number of issues in the {mod}`expertsystem` are correlated
(e.g. [ComPWA/expertsystem#40](https://github.com/ComPWA/expertsystem/issues/40), [ComPWA/expertsystem#44](https://github.com/ComPWA/expertsystem/issues/44),
[ComPWA/expertsystem#22](https://github.com/ComPWA/expertsystem/issues/22)) so that resulting PRs (in this case,
[ComPWA/expertsystem#42](https://github.com/ComPWA/expertsystem/pull/42)) lacked direction. This led us to consider ADRs.
Technical story: A large number of issues in the {mod}`expertsystem` are correlated (e.g. [ComPWA/expertsystem#40](https://github.com/ComPWA/expertsystem/issues/40), [ComPWA/expertsystem#44](https://github.com/ComPWA/expertsystem/issues/44), [ComPWA/expertsystem#22](https://github.com/ComPWA/expertsystem/issues/22)) so that resulting PRs (in this case, [ComPWA/expertsystem#42](https://github.com/ComPWA/expertsystem/pull/42)) lacked direction. This led us to consider ADRs.

## Context and Problem Statement

We want to record architectural decisions made in this project. Which format and
structure should these records follow?
We want to record architectural decisions made in this project. Which format and structure should these records follow?

## Considered Options

- [MADR](https://adr.github.io/madr/) 2.1.2 – The Markdown Architectural Decision
Records
- [Michael Nygard's template](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions)
– The first incarnation of the term "ADR"
- [Sustainable Architectural Decisions](https://www.infoq.com/articles/sustainable-architectural-design-decisions)
– The Y-Statements
- Other templates listed at
[github.com/joelparkerhenderson/architecture_decision_record](https://github.com/joelparkerhenderson/architecture_decision_record).
- [MADR](https://adr.github.io/madr/) 2.1.2 – The Markdown Architectural Decision Records
- [Michael Nygard's template](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions) – The first incarnation of the term "ADR"
- [Sustainable Architectural Decisions](https://www.infoq.com/articles/sustainable-architectural-design-decisions) – The Y-Statements
- Other templates listed at [github.com/joelparkerhenderson/architecture_decision_record](https://github.com/joelparkerhenderson/architecture_decision_record).
- Formless – No conventions for file format and structure

## Decision Outcome

Chosen option: "MADR 2.1.2", because

- Implicit assumptions should be made explicit. Design documentation is important to
enable people understanding the decisions later on. See also
[A rational design process: How and why to fake it](https://ieeexplore.ieee.org/document/6312940/).
- Implicit assumptions should be made explicit. Design documentation is important to enable people understanding the decisions later on. See also [A rational design process: How and why to fake it](https://ieeexplore.ieee.org/document/6312940/).
- The MADR format is lean and fits our development style.
- The MADR structure is comprehensible and facilitates usage & maintenance.
- The MADR project is vivid.
Expand Down
Loading
Loading