matrix-org / matrix-org/matrix.org
Refresh clients data automatically
Nobody has claimed this yet.
- 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
*.mdin/content/ecosystem/clients, and for each file- Parses the frontmatter
- Reads a
definition_fileurl (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:
- Is it acceptable to ask for the definition_file to be accessible via https?
- What information can be updated by the app maintainer, and what information can only be updated by an editor/curator?
- What format should the definition_file follow?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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