Skip to content

Do not tag traces with shared libraries Git metadata#483

Merged
nikita-tkachenko-datadog merged 2 commits into
masterfrom
nikita-tkachenko/ignore-shared-libs-git-info
Jan 7, 2025
Merged

Do not tag traces with shared libraries Git metadata#483
nikita-tkachenko-datadog merged 2 commits into
masterfrom
nikita-tkachenko/ignore-shared-libs-git-info

Conversation

@nikita-tkachenko-datadog

Copy link
Copy Markdown
Collaborator

Requirements for Contributing to this repository

  • Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
  • The pull request must only fix one issue at the time.
  • The pull request must update the test suite to demonstrate the changed functionality.
  • After you create the pull request, all status checks must be pass before a maintainer reviews your contribution. For more details, please see CONTRIBUTING.

What does this PR do?

Updates Git checkout listener to ignore shared libraries checkouts.

When a pipeline uses a shared library, the library typically resides in a separate repo and is being checked out when the pipeline is run.
These library checkouts trigger the plugin's Git checkout listener just as any other Git repo checkout.
However we do not want to tag traces with shared libraries' Git metadata.

Description of the Change

Alternate Designs

Possible Drawbacks

Verification Process

Additional Notes

Release Notes

Review checklist (to be filled by reviewers)

  • Feature or bug fix MUST have appropriate tests (unit, integration, etc...)
  • PR title must be written as a CHANGELOG entry (see why)
  • Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
  • PR must have one changelog/ label attached. If applicable it should have the backward-incompatible label attached.
  • PR should not have do-not-merge/ label attached.
  • If Applicable, issue must have kind/ and severity/ labels attached at least.

@nikita-tkachenko-datadog nikita-tkachenko-datadog added the changelog/Fixed Fixed features results into a bug fix version bump label Dec 20, 2024
@nikita-tkachenko-datadog
nikita-tkachenko-datadog marked this pull request as ready for review January 2, 2025 15:36
Comment on lines +169 to +176
FilePath parent = workspace.getParent();
if (parent == null) {
return false;
}
String name = parent.getName();
if (!name.endsWith("@libs")) {
return false;
}

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this happen in the workspace instance (not in the parent) ?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The parent is the common folder where all shared libraries for a pipeline are stored, while the workspace is a folder which contains a specific shared library (for example /var/jenkins_home/workspace/test-pipeline-shared-library@libs/fbf88f8b22e51df9124d2af6a9cc72fd2567aecb8b4f0d8b40967d2a6ebbe198).
The names look like some kind of hashes, I don't think we can get any useful clues from checking them

@nikita-tkachenko-datadog
nikita-tkachenko-datadog merged commit e635073 into master Jan 7, 2025
@nikita-tkachenko-datadog
nikita-tkachenko-datadog deleted the nikita-tkachenko/ignore-shared-libs-git-info branch January 7, 2025 10:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog/Fixed Fixed features results into a bug fix version bump

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants