matrix-org / matrix-org/matrix.org

Refresh clients data automatically

Open
#2,010 11 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help wanted
Dominant language
JavaScript
Stars
616
Forks
463
Avg merge
2d 3h
Merged PRs (30d)
19

Description

As of now, clients data in https://matrix.org/ecosystem/clients/ is not refreshed automatically. We can implement a GH Action to fetch the client information "somewhere" and update the data.

My naive approach would be to have a GH Action running every 24h that:

  • Fetches all the *.md in /content/ecosystem/clients, and for each file
    • Parses the frontmatter
    • Reads a definition_file url (https? git? TBD)
    • Fetches the definition file in the url that contains the updated data
    • Updates the data in the frontmatter of the .md file
  • Opens a new PR to update the clients data
  • Closes old unreviewed PRs it had previously opened

What's left to define:

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Markdown files under /content/ecosystem/clients and the linked comments about definition_file format, access, and editable fields. Confirm the maintainer and curator boundaries before designing the GitHub Action. Done means the action can refresh client data, open an update PR, and close its older unreviewed PRs.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd, content
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.