Prepare project for public release
Some checks failed
CI / test (3.10) (push) Has been cancelled
CI / test (3.12) (push) Has been cancelled
CI / test (3.13) (push) Has been cancelled
CI / container (push) Has been cancelled

This commit is contained in:
Johan Lundberg 2026-07-30 23:22:10 +02:00
commit dbc7464b58
21 changed files with 1780 additions and 0 deletions

67
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View file

@ -0,0 +1,67 @@
name: Bug report
description: Report reproducible incorrect behavior
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Do not include credentials, private addresses, AP names, `config.ini`,
`.env`, `state.json`, or unredacted logs. Report security issues using
the private process in SECURITY.md.
- type: input
id: version
attributes:
label: Version or commit
placeholder: v0.1.0 or commit SHA
validations:
required: true
- type: dropdown
id: installation
attributes:
label: Installation mode
options:
- Docker Compose
- systemd
- Manual Python invocation
validations:
required: true
- type: input
id: runtime
attributes:
label: Runtime
description: Python version, or Docker Engine and Compose versions
validations:
required: true
- type: input
id: controller
attributes:
label: Controller model and IOS XE version
description: Do not include hostnames, addresses, serial numbers, or AP names.
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behavior
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual behavior and redacted logs
validations:
required: true
- type: checkboxes
id: privacy
attributes:
label: Data-safety confirmation
options:
- label: I removed credentials, private infrastructure details, and personal data.
required: true

14
.github/dependabot.yml vendored Normal file
View file

@ -0,0 +1,14 @@
version: 2
updates:
- package-ecosystem: pip
directory: /
schedule:
interval: monthly
- package-ecosystem: docker
directory: /
schedule:
interval: monthly
- package-ecosystem: github-actions
directory: /
schedule:
interval: monthly

18
.github/pull_request_template.md vendored Normal file
View file

@ -0,0 +1,18 @@
## Summary
Describe the problem and the focused solution.
## Verification
- [ ] `python -m py_compile wlc_monitor.py`
- [ ] `python -m unittest discover -v`
- [ ] `python -m pip check`
- [ ] Docker checks run, or not applicable
- [ ] User-facing documentation updated, or not applicable
- [ ] No credentials, private infrastructure data, runtime state, or personal data
are present in the diff
## Operational impact
Call out compatibility, configuration, alerting, state-migration, or deployment
effects.

35
.github/workflows/ci.yml vendored Normal file
View file

@ -0,0 +1,35 @@
name: CI
on:
push:
pull_request:
permissions:
contents: read
jobs:
test:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: ["3.10", "3.12", "3.13"]
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
cache: pip
- run: python -m pip install --upgrade pip
- run: python -m pip install -r requirements.txt
- run: python -m py_compile wlc_monitor.py
- run: python -m unittest discover -v
- run: python -m pip check
container:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: cp .env.example .env
- run: docker compose config --quiet
- run: docker build --tag wlc-monitor:test .