development-guide icon indicating copy to clipboard operation
development-guide copied to clipboard

Separate Development Tools from the Development Guide

Open mcdonnnj opened this issue 5 years ago • 3 comments

🚀 Feature Proposal

Separate the Development Tools currently stored in project_setup/scripts into their own repository as a Python package.

Motivation

@hillaryj created an issue to add testing to the scripts in the above mentioned directory in #31 , but I believe it would be better to separate tooling from documentation.

Example

One would be able to install the development tools as a Python package a la pip install git+https://github.com/cisagov/development-tools.git and the scripts would be available in the environment.

Pitch

As it stands it is difficult to add testing and keep Python related skeleton updates current in this project because:

  1. It descends from cisagov/skeleton-generic instead of cisagov/skeleton-python-library
  2. It is a repository trying to store both documentation about our development process and the tools that are used

Moving the tooling into its own repository would allow it to be configured as a typical Python package, which would allow for our CI/CD pipeline to be implemented as it typically would for such a project. This will make it easier to add new tooling, eliminate duplicate code between tools, and ensure that testing is done automatically.

mcdonnnj avatar Oct 29 '20 14:10 mcdonnnj

I wholeheartedly support this change.

jsf9k avatar Oct 29 '20 15:10 jsf9k

I've created a new skeleton-python-library-based repo at https://github.com/cisagov/development-tools

hillaryj avatar Dec 01 '20 18:12 hillaryj

I've created a new skeleton-python-library-based repo at https://github.com/cisagov/development-tools

I don't think this was the intent. We wanted to move each development tool to its own repo so we can apply all our CI machinery to it.

jsf9k avatar Dec 01 '20 20:12 jsf9k