Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add audit:repositories command #142

Merged
merged 1 commit into from
May 12, 2021

Conversation

dblandin
Copy link
Member

Fetch and display information for repositories within the Artsy GitHub organization.

Initially to be used to aid in our switch from a default branch of master to main.

Usage:

$ artsy audit:repositories
$ artsy audit:repositories --csv
$ artsy audit:repositories --csv --default-branch=main
$ artsy audit:repositories --csv --default-branch=main --pushed=">2021-05-01"

@kajatiger Thought this might be a useful command to help with artsy/README#387!

@dblandin dblandin requested a review from kajatiger May 11, 2021 09:04
@dblandin dblandin force-pushed the dblandin/add-audit-repositories-command branch from 9ff8440 to 13bd58c Compare May 11, 2021 09:06
Fetch and display information for repositories within the Artsy GitHub
organization.

Initially to be used to aid our switch from a default branch of `master` to
`main`.

Usage:

```
$ artsy audit:repositories
$ artsy audit:repositories --csv
$ artsy audit:repositories --csv --default-branch=main
$ artsy audit:repositories --csv --default-branch=main --pushed=">2021-05-01"
```
@dblandin dblandin force-pushed the dblandin/add-audit-repositories-command branch from 13bd58c to 34b150e Compare May 11, 2021 13:59
@kajatiger
Copy link

Wow, this is a great idea! I was wondering how I could test this out locally. Can I somehow install the branch version with the npm command and try out the commands?
It could also be interesting to expand this with informations about maintainance/usage of the repository to discover unused or dead repos in order to keep the organization clean.

@kajatiger kajatiger merged commit d816dd1 into master May 12, 2021
@kajatiger kajatiger deleted the dblandin/add-audit-repositories-command branch May 12, 2021 14:58
@artsyit
Copy link
Contributor

artsyit commented May 12, 2021

🚀 PR was released in v0.18.0 🚀

@dblandin
Copy link
Member Author

Wow, this is a great idea! I was wondering how I could test this out locally. Can I somehow install the branch version with the npm command and try out the commands?

We should definitely add some development instructions in the README!

The process right now would be to clone the repo locally, checkout the branch, install dependencies, setup, environment variables necessary... and then you can run against the local project via:

$ bin/run [command]
$ bin/run audit:repositories --csv

It could also be interesting to expand this with informations about maintainance/usage of the repository to discover unused or dead repos in order to keep the organization clean.

I like that idea! Another thought I have it that this would potentially made a good Peril task/rule. We have a similar rule that checks every day for repositories without a license and mangees a GitHub issue on the repository (link). We might consider a similar "Switch default branch to main" GitHub issue rule.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants