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

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

Open
kdmccormick opened this issue Jul 12, 2023 · 1 comment
Open

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

kdmccormick opened this issue Jul 12, 2023 · 1 comment

Comments

@kdmccormick
Copy link
Member

Background

Every repo has an "About" section:
image

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

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
Copy link
Member Author

Very WIP: #428

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

No branches or pull requests

1 participant