Repo Check: Sync repo "About" details from catalog-info.yml - Githubissues

openedx / repo-tools

Tools for repo maintenance, etc.

Apache License 2.0

30 stars 39 forks source link

Repo Check: Sync repo "About" details from catalog-info.yml #415

Open kdmccormick opened 1 year ago

kdmccormick commented 1 year ago

Background

Every repo has an "About" section:

Anyone with Maintain or Admin rights on the repo can edit it:

Over time, we forsee fewer devs having Maintain & Admin rights on repos, so editing these would generally require opening an Axim request.

However, we could make it self-service for anyone with Write access if we sourced this data from catalog-info.yml: https://github.com/openedx/xblock-utils/blob/0a47da96ae164a8209f851de3b73dbdf6980b865/catalog-info.yaml#L10-L17

Acceptance Criteria

Write a repo check that:

is_relevant on all repos with a catalog-info.yml
checks that:
- if a description is set in catalog-info.yml, it matches the repo's "About: Description"
- if any links are provided in catalog-info.yml, the first link matches the repo's "About: Website"
if necessary, fixes the above by updating the repo's About section based on what's in catalog-info.yml

Future work

We could use catalog-info.yml to set the Topics (in the image: hacktoberfest and backend-service) as well.

kdmccormick commented 11 months ago

Very WIP: https://github.com/openedx/repo-tools/pull/428