redhat-developer / redhat-developer/rhdh-plugin-export-utils

source.json should be a source.yaml, just for consistency

Open
#19 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
2
Forks
15
Avg merge
11h 5m
Merged PRs (30d)
2

Description

PRs like this:

creates a source.json (manually formatted for readability) like this:

{
  "repo": "https://github.com/backstage/community-plugins",
  "repo-ref": "335037a9f57eef5a989363cb9779cfaeb8c81f9b",
  "repo-flat": false
}

Since everything in the Backstage world is using YAMLs, and also the PR creates a plugins-list.yaml I would recommend to create a source.yaml as well

repo: "https://github.com/backstage/community-plugins"
repo-ref: "335037a9f57eef5a989363cb9779cfaeb8c81f9b"
repo-flat: false

Contributor guide

No contributing guide indexed for this repository

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

Review the referenced PR and compare the existing source.json with plugins-list.yaml to find where the source metadata is created or consumed. Replace the JSON metadata with source.yaml in the same workflow, preserving repo, repo-ref, and repo-flat; the export process should continue to produce valid, consistently formatted metadata.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.