Skip to content

Latest commit

 

History

History
62 lines (45 loc) · 2.36 KB

MAINTAINERS.md

File metadata and controls

62 lines (45 loc) · 2.36 KB
Raw

Maintaining Bandersnatch

This document sets out the roles, processes and responsibilities bandersnatch maintainers hold and can conduct.

Summary of being a Maintainer of bandersnatch

  • Issue Triage
    • Assesses if the Issue is accurate + reproducible
    • If the issue is a feature request, assesses if it fits the bandersnatch mission
  • PR Merging
    • Accesses Pull Requests for suitability and adherence to the bandersnatch mission
  • It is preferred that big changes be pulling in from branches via Pull Requests
    • Peer reviewed by another maintainer
  • Releases
  • You will have "the commit bit" access

Links to key mentioned files

Processes

Evaluating Issues and Pull Requests

Please always think of the mission of bandersnatch. We should just mirror in a compatible way like a PEP381 mirror. Simple is always better than complex and all bug issues need to be reproducible for our developers.

pyup.io

  • Remember it's not perfect
    • It does not take into account modules pinned dependencies
    • e.g. If requests wants urllib3<1.25 pyup.io can still try and update it
  • Until we have CI that effectively runs pip freeze from time to time we should recheck our minimal deps that we pin in requirements.txt

Releasing to PyPI

Every maintainer can release to PyPI. A maintainer should have agreement of two or more Maintainers that it is a suitable time for a release.

Release Process

  • Update src/bandersnatch/__init__.py version
  • Update the Change Log with difference from the last release
  • Push / Merge to Master
  • Create a GitHub Release
    • Tag with the semantic version number
  • Build a sdist + wheel
  • Use twine to upload to PyPI

Building Docker Image

example build commands

sudo docker build --build-arg WITH_SWIFT=yes --build-arg PY_VERSION=3.9 -t pypa/bandersnatch:3.9-swift . sudo docker build --build-arg PY_VERSION=3.8 -t pypa/bandersnatch:3.8 . sudo docker build -t pypa/bandersnatch:3.9 .