mozilla / pd-cli

A Product Delivery CLI toolbox of awesomeness

pd-cli

A Product Delivery CLI toolbox of awesomeness

Install

Install dep

go get github.com/mozilla/pd-cli
cd $GOPATH/src/github.com/mozilla/pd-cli
dep ensure && go install .
pd-cli -h

Github Access

The pd-cli requires a Github access token to perform most of its commands.

• Create a GH Personal Access Token
• Give the token all repo permissions
• Set the token in the environment variable GH_ACCESS_TOKEN

Usage

• Print help:
  • pd-cli help
  • pd-cli repo help
  • pd-cli create-milestone help
• Check a repo (these are the same):
  • pd-cli repo check all github.com/mozilla/pd-cli
  • pd-cli repo check all mozilla/pd-cli
• Specific checks:
  • pd-cli repo check help -- prints help
  • pd-cli repo check topic owner/repo -- checks for Product Delivery repo topics
  • pd-cli repo check labels owner/repo -- verifies Product Delivery labels are correct
  • `pd-cli repo check unassigned owner/repo`` -- checks all P1 issues are assigned to somebody
  • `pd-cli repo check unlabled owner/repo`` -- finds issues that do not have a label
  • `pd-cli repo check milestones owner/repo`` -- verifies milestones have a project to track them
• Initializing a repo:
  • pd-cli repo init mozilla/pd-cli - creates labels and a default project
  • pd-cli repo init -p "first project" mozilla/pd-cli - creates labels and a specific project
  • pd-cli repo create-milestone -m "Version 2.0" mozilla/pd-cli - creates a new milestone
  • pd-cli repo create-project -p "first project" mozilla/pd-cli - creates a project

pd-cli's Issues

Missing newline in assigned P1s check

Note the missing newline after "Django 1.11"

Checking Unassigned Issues
 - Error: 1 unassigned P1 issues
  #1180 Upgrade to Django 1.11Checking Unlabled
 - OK. All issues are labeled

Improvement should be seen as an enhancement label

The PD Project Managment Standard say that "improvement" is an enhancement label that should be green, but pd-cli insists it is a "component/misc label" label that should be purple.

 - Error: [improvement] should have color #5319e7

Milestone check errors are missing new lines

When checking that milestones have matching projects, the errors given don't include new lines, which makes the output hard to read.

Checking Milestones
 - Error: preference-rollout does not have a matching project - Error: preference-experiments does not have a matching project - Error: pioneer does not have a matching project - Error: js-refactor does not have a matching project - Error: opt-out-studies does not have a matching project - OK. Milestones verified

CODE_OF_CONDUCT.md file missing

As of January 1 2019, Mozilla requires that all GitHub projects include this CODE_OF_CONDUCT.md file in the project root. The file has two parts:

1. Required Text - All text under the headings Community Participation Guidelines and How to Report, are required, and should not be altered.
2. Optional Text - The Project Specific Etiquette heading provides a space to speak more specifically about ways people can work effectively and inclusively together. Some examples of those can be found on the Firefox Debugger project, and Common Voice. (The optional part is commented out in the raw template file, and will not be visible until you modify and uncomment that part.)

If you have any questions about this file, or Code of Conduct policies and procedures, please see Mozilla-GitHub-Standards or email [email protected].

(Message COC001)

Projects are created without automation

The projects created by this tool lack automation so we can't use the "Track project progress" feature. And as far as I can tell there's no way to retroactively enable automation.

create-milestone doesn't do anything if a repo is not specified

Steps to reproduce

$ pd-cli repo create-milestone -m multi-pref-study

Expected

An error is thrown since no repository was specified

Actual

Nothing happens. No output is given, and no changes happen to any repo.

Wiki changes

FYI: The following changes were made to this repository's wiki:

• defacing spam has been removed

• Restricting write access to contributors is strongly encouraged. Please make that change (documentation).

These were made as the result of a recent automated defacement of publically writeable wikis.

init-labels doesn't set up colors correctly

After running pd-cli repo init-labels owner/repo and then running pd-cli repo check all owner/repo I got the following:

Checking Labels
 - OK. [P1] verified
 - OK. [P2] verified
 - OK. [P3] verified
 - OK. [P5] verified
 - OK. [bug] verified
 - OK. [documentation] verified
 - Error: [duplicate] should have color #5319e7
 - Error: [enhancement] should have color #5319e7
 - OK. [fix] verified
 - Error: [good first issue] should have color #5319e7
 - Error: [help wanted] should have color #5319e7
 - OK. [improvement] verified
 - Error: [invalid] should have color #5319e7
 - OK. [new-feature] verified
 - OK. [proposal] verified
 - OK. [question] verified
 - OK. [security] verified
 - OK. [support-request] verified
 - Error: [wontfix] should have color #5319e7

Colors were not set on a few of the labels.