ministryofjustice / ministryofjustice/developer-experience-github-audit

[GitHub Audit CLI] - Initial Release

Open
#161 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
2
Forks
2
Avg merge
10d 5h
Merged PRs (30d)
2

Description

🧑‍💼 User Need

As a DevX team member
I want the audit CLI toolset packaged and released as an internal versioned artifcat
so that a stable documented reference point is available to be built from long-term

💡 Value / Purpose

  • An internal release of the toolset provides a clear snapshot of the toolset at a known "good" state, and lays the foundation for future releases and enhancements.
  • It demonstrates the toolset is in a "ready-to-use" state, rather than a collection of scripts.

🛠️ Description / Context

  • Verify the current state of main.py and confirm all scripts under scripts/ are wired up and running cleanly via config/audit_config.yaml and main.py.
  • Prepare the toolset for its first internal release covering:
    • pyproject.toml entrypoint configured e.g. audit-cli = "main:main"
    • Version set in pyproject.toml e.g. 0.1.0
    • All scripts verified to be running cleanly e.g. audit-cli --scripts list_repos etc.
    • uv sync produces a clean installation
    • GitHub release created with release notes summarising what's included
    • Release is internal only - not publushed on PyPi/public registries etc

🧪 Testing steps

  • uv sync completes without errors
  • audit-cli --scripts <script name> runs for all scripts without errors (use a limited set for ease)
  • Release notes accurately describe the toolset scope and known limitations

✅ Definition of Done

  • pyproject.toml entrypoint and version configured
  • All scripts verified via unified entrypoint
  • Internal GitHub release created with release notes
  • Known limitations and long-term recommendations documented
  • Document work completed in Developer Experience Team SharePoint
  • Identify opportunities for improvement based on engineering portal release process and create follow up tickets where applicable

❓ Additional Information

  • This release is internal only - public releases is out of scope / not planned.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing main.py, scripts/, config/audit_config.yaml, and pyproject.toml to understand the unified entrypoint and current script wiring. Run uv sync and audit-cli --scripts with a limited script set, then verify the entrypoint and version. Done means all scripts run cleanly, an internal GitHub release has accurate notes, and known limitations and recommendations are documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, python
Domain
cli, documentation, release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.