jfrog / jfrog/setup-jfrog-cli

Automatically configured JFROG_CLI_BUILD_NAME not specific enough

Open
#159 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature request
Dominant language
TypeScript
Stars
266
Forks
110
Avg merge
3d 15h
Merged PRs (30d)
3

Description

Is your feature request related to a problem? Please describe.

Hi,

We are running into the issue that the automatically configured JFROG_CLI_BUILD_NAME which is currently set to the workflow name is not specific enough.

We have a lot of repositories, all publishing to the same project in JFROG into the same build-info repository. If we examine the build-info repository all build names for all repositories are the same: "CI/CD", since all repositories have the same name for the CI/CD workflow.

Describe the solution you'd like to see

I think it would make sense to include the repository name as well besides the workflow name.

https://github.com/jfrog/setup-jfrog-cli/blob/ac320860ee08886f9762fc8eb4186f994deadecb/src/utils.ts#L344C1-L345C1
let buildNameEnv: string | undefined = process.env.GITHUB_WORKFLOW;
to

let buildNameEnv: string | undefined = process.env.GITHUB_REPOSITORY + '/' + process.env.GITHUB_WORKFLOW;
This would allow us to identify the build-info by its name, instead of having

Describe alternatives you've considered

The alternative would be to require all teams to add an extra run step to their workflows overriding the too generic JFROG_CLI_BUILD_NAME.

Additional context

No response

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

Read src/utils.ts at the referenced lines where JFROG_CLI_BUILD_NAME is derived from GITHUB_WORKFLOW. Check the existing project tests before making the build name repository-specific, and consider the work done when builds from different repositories no longer share the same automatically configured name.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, typescript
Domain
ci-cd
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.