Skip to content

Repository files navigation

.github

Org-wide community health files, shared release machinery, and the GitHub profile for PyDevices. This repository does not ship a product; it is what every other PyDevices repository points at for the parts they'd otherwise duplicate.

What lives here

  • Community health defaultsCONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, SUPPORT.md, PULL_REQUEST_TEMPLATE.md, and .github/ISSUE_TEMPLATE/ — GitHub's fallback for any repo in the org that doesn't define its own.
  • profile/README.md — the org profile page shown on github.com/PyDevices.
  • The reusable publishing workflows and the tag contract.github/workflows/reusable-*.yml implement the whole release chain (prepare a release PR, tag on merge, build, publish to TestPyPI, attach assets, request MIP publication, optionally publish to PyPI, report health) shared by seven publishing repositories. Callers pin a publishing-vN tag, never a branch; those tags are immutable by policy and by an active GitHub tag ruleset on this repository that blocks moving or deleting one. See docs/publishing-automation.md for the runbook and docs/workflows.md for the full workflow inventory.
  • RELEASE_HEALTH.md — one row per published distribution (version, TestPyPI/assets/MIP/PyPI outcome, last-updated, linked to the run), regenerated by .github/workflows/release-health.yml from release-health/data.json every time a publishing repository's release chain reports in. Don't hand-edit either file.
  • The workspace manifestworkspace/repos.json is the single source of truth for the multi-repository local workspace (every PyDevices repo, its local checkout name, role, and status); workspace/bootstrap.sh clones or updates every active entry as siblings on disk. Other copies of this list (see .cursor/environment.json) are meant to converge on it, not fork from it.
  • The repository database and site generatordata/repos_db.json is the single source of truth for the repository map: tier, description, buttons, and where each repo's landing page is published. scripts/generate_sites.py renders it into the org portal, into per-repo .site/ trees, into profile/README.md, and into pydevices/docs/ecosystem.md. Edit the database, not the generated markup — run the generator by hand from a full workspace checkout (python3 dotgithub/scripts/generate_sites.py) after editing it; it validates the database first and is idempotent.
  • Historydocs/history.md: how the organization came to be, and a dated chronology of every repository.
  • Org docsdocs/ covers repo layout, doc style and docstring conventions, how the ReadTheDocs sites build, GitHub presence (Discussions/Issues/Pages/licensing), the platform roadmap, and the public modernization roadmap.

Board / Detect inventory docs live in pydevices/docs (Pages).

Website: https://pydevices.github.io/

This repo is the org-level glue for community health files, shared release automation, issue templates, and shared docs. It does not publish a product Pages site of its own; the product repos publish their own Pages content (or a page generated into the portal), while this repo provides the shared org profile, publishing machinery, and documentation references.

About

Org-wide community health files, GitHub profile, and the shared release-automation workflows that publish every PyDevices package.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages