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

PR title and source.json should incl packaged version

Open
#18 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:

makes it difficult to understand which version this bundles. For me it looks like it picks a "random" Git hash/repo-ref. But @davidfestal explained me that it already picks up the latest release of an npm package.

To make it more explicit and readable I like to suggest that the title should include that npm version.

It would be nice if the source.json also includes this version. This makes it easier later to grep the repo for specific versions.

Current workspaces/npm/source.json (manually formatted for readability):

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

And kind of extra attributes like this would be great:

{
  "repo": "https://github.com/backstage/community-plugins",
  "repo-ref": "335037a9f57eef5a989363cb9779cfaeb8c81f9b",
  "repo-flat": false,
  "workspace-path": "workspaces/npm",
  "npm-version": "1.0.0"
}

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

Start with the export flow that creates PR titles and workspaces/npm/source.json. Trace how the packaged npm version is currently selected, then identify where both the title and source metadata are assembled. Done means the generated title and source.json expose the same package version alongside the existing repository fields.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
release, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.