Skip to content
This repository was archived by the owner on Apr 14, 2026. It is now read-only.

Commit 15191a9

Browse files
kaitjkaitj
committed
Initialize StyxPodman repo
1 parent 0d06660 commit 15191a9

22 files changed

Lines changed: 2060 additions & 0 deletions

‎.github/ISSUE_TEMPLATE/bug_report.yaml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Bug Report
2+
description: This is a template for reporting a bug.
3+
# If you want to enable automatic linking to projects,
4+
# uncomment the following line and replace the project ID
5+
# with the ID of your project.
6+
# projects: ["childmindresearch/1"]
7+
title: 'Bug: '
8+
labels: [bug]
9+
body:
10+
- type: textarea
11+
id: description
12+
attributes:
13+
label: Description
14+
description: Please provide a clear and concise description of the bug.
15+
placeholder: Describe the bug here
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: steps-to-reproduce
20+
attributes:
21+
label: Steps to Reproduce
22+
description: Please provide detailed steps to reproduce the bug.
23+
placeholder: Describe the steps to reproduce the bug here.
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: expected-results
28+
attributes:
29+
label: Expected Results
30+
description: Please describe what you expected to happen.
31+
placeholder: Describe the expected results here.
32+
validations:
33+
required: true
34+
- type: textarea
35+
id: actual-results
36+
attributes:
37+
label: Actual Results
38+
description: Please describe what actually happened.
39+
placeholder: Describe the actual results here.
40+
validations:
41+
required: true
42+
- type: textarea
43+
id: additional-notes
44+
attributes:
45+
label: Additional Notes
46+
description: Add any additional notes or context here.
47+
placeholder: Add additional notes here.

‎.github/ISSUE_TEMPLATE/development_task.yaml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Development Task
2+
description: This is a template for a development task
3+
# If you want to enable automatic linking to projects,
4+
# uncomment the following line and replace the project ID
5+
# with the ID of your project.
6+
# projects: ["childmindresearch/1"]
7+
title: 'Task: '
8+
labels: [task]
9+
body:
10+
- type: textarea
11+
id: description
12+
attributes:
13+
label: Description
14+
description: What is the task about? Why is it needed? What is the current state, if any?
15+
placeholder: Describe the task here
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: tasks
20+
attributes:
21+
label: Tasks
22+
description: What are the concrete (sub-)tasks that need to be performed?
23+
placeholder: Describe the tasks here.
24+
value: '- [ ] Task 1'
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: freeform-notes
29+
attributes:
30+
label: Freeform Notes
31+
description: Add any additional notes here.
32+
placeholder: Add notes here.

‎.github/ISSUE_TEMPLATE/support_request.yaml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Support Request
2+
description: This is a template for submitting a support request.
3+
# If you want to enable automatic linking to projects,
4+
# uncomment the following line and replace the project ID
5+
# with the ID of your project.
6+
# projects: ["childmindresearch/1"]
7+
title: 'Support: '
8+
labels: [question]
9+
body:
10+
- type: textarea
11+
id: issue-description
12+
attributes:
13+
label: Issue Description
14+
description: Please provide a clear and concise description of the issue you are facing.
15+
placeholder: Describe the issue here
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: environment-details
20+
attributes:
21+
label: Environment Details
22+
description: Please provide details about your environment, including system specifications, software versions, etc.
23+
placeholder: Describe your environment details here.
24+
validations:
25+
required: false
26+
- type: textarea
27+
id: attempted-solutions
28+
attributes:
29+
label: Attempted Solutions
30+
description: Describe any steps you have already taken to resolve the issue.
31+
placeholder: Describe any attempted solutions here.
32+
validations:
33+
required: false
34+
- type: textarea
35+
id: reproduction-steps
36+
attributes:
37+
label: Reproduction Steps
38+
description: If applicable, provide steps to reproduce the issue.
39+
placeholder: Describe the steps to reproduce the issue, if applicable.
40+
validations:
41+
required: false
42+
- type: textarea
43+
id: additional-notes
44+
attributes:
45+
label: Additional Notes
46+
description: Add any other context or screenshots about the support request here.
47+
placeholder: Add additional notes or screenshots here.

‎.github/dependabot.yaml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Please see the documentation for all configuration options:
2+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
3+
4+
version: 2
5+
updates:
6+
- package-ecosystem: pip
7+
directory: /
8+
schedule:
9+
interval: monthly
10+
groups:
11+
production-dependencies:
12+
dependency-type: production
13+
development-dependencies:
14+
dependency-type: development
15+
- package-ecosystem: github-actions
16+
directory: /
17+
schedule:
18+
interval: monthly

‎.github/workflows/docs.yaml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Build and publish docs
2+
3+
permissions:
4+
contents: read
5+
pages: write
6+
id-token: write
7+
8+
concurrency:
9+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
10+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
11+
group: pages
12+
cancel-in-progress: false
13+
14+
on:
15+
workflow_run:
16+
workflows: [Python Tests]
17+
types:
18+
- completed
19+
branches:
20+
- main
21+
workflow_dispatch:
22+
23+
jobs:
24+
build-and-publish-docs:
25+
if: ${{ github.event.workflow_run.conclusion == 'success' }}
26+
runs-on: ubuntu-latest
27+
environment:
28+
name: github-pages
29+
url: ${{ steps.deployment.outputs.page_url }}
30+
steps:
31+
- uses: actions/checkout@v5
32+
- name: Install uv
33+
uses: astral-sh/setup-uv@v7
34+
with:
35+
enable-cache: true
36+
- name: Set up Python
37+
uses: actions/setup-python@v6
38+
with:
39+
python-version-file: pyproject.toml
40+
- name: Install the project
41+
run: uv sync --only-group docs
42+
- name: Build docs
43+
run: |
44+
APP_MODULE_NAME=$(ls src -U | head -1) # Get the first module name in the src directory
45+
uv run pdoc src/"$APP_MODULE_NAME" -o docs_build -t docs/pdoc-theme --docformat google
46+
- name: Setup Pages
47+
uses: actions/configure-pages@v5
48+
- name: Upload artifact
49+
uses: actions/upload-pages-artifact@v4
50+
with:
51+
path: ./docs_build
52+
- name: Deploy to GitHub Pages
53+
id: deployment
54+
uses: actions/deploy-pages@v4
55+
- name: Deploy to Cloudflare Pages
56+
id: cloudflare-deployment
57+
uses: cloudflare/wrangler-action@v3
58+
with:
59+
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
60+
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
61+
command: pages deploy docs_build/ --project-name=styxpodman --branch=main

‎.github/workflows/publish-pypi.yaml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Publish to PyPi
2+
3+
permissions:
4+
actions: write
5+
6+
on:
7+
push:
8+
tags:
9+
- '*'
10+
11+
jobs:
12+
pypi-release:
13+
name: PyPi Release
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- uses: actions/checkout@v5
18+
19+
- name: Setup uv
20+
uses: astral-sh/setup-uv@v7
21+
with:
22+
enable-cache: true
23+
24+
- name: Install dependencies and build
25+
run: |
26+
uv sync --frozen --no-dev --no-install-project
27+
uv build
28+
29+
- name: Publish to PyPi
30+
id: pypi_publish
31+
uses: pypa/gh-action-pypi-publish@release/v1
32+
with:
33+
user: __token__
34+
password: ${{ secrets.PYPI_TOKEN }}
35+
verbose: true

‎.github/workflows/test.yaml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: Python Tests
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
9+
jobs:
10+
unit:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v5
14+
15+
- name: Setup uv
16+
uses: astral-sh/setup-uv@v7
17+
with:
18+
enable-cache: true
19+
20+
- name: Run tests
21+
id: run-tests
22+
run: >
23+
uv run --frozen pytest \
24+
--junitxml=pytest.xml \
25+
--cov-report=term-missing:skip-covered \
26+
--cov-report=xml:coverage.xml \
27+
--cov=src tests \
28+
--log-level=DEBUG \
29+
--verbose
30+
31+
- name: Upload coverage to Codecov
32+
uses: codecov/codecov-action@v5
33+
with:
34+
token: ${{ secrets.CODECOV_TOKEN }}
35+
verbose: true
36+
37+
ruff:
38+
runs-on: ubuntu-latest
39+
steps:
40+
- uses: actions/checkout@v5
41+
42+
- name: Setup uv
43+
uses: astral-sh/setup-uv@v7
44+
with:
45+
enable-cache: true
46+
47+
- name: Ruff format
48+
run: uv run ruff format --check
49+
50+
- name: Ruff check
51+
run: uv run ruff check
52+
53+
mypy:
54+
runs-on: ubuntu-latest
55+
steps:
56+
- uses: actions/checkout@v5
57+
58+
- name: Setup uv
59+
uses: astral-sh/setup-uv@v7
60+
with:
61+
enable-cache: true
62+
63+
- run: uv run mypy .

0 commit comments

Comments
 (0)