Skip to content

Fix setting Datadog API key credentials with configuration as code#438

Merged
nikita-tkachenko-datadog merged 4 commits into
masterfrom
nikita-tkachenko/casc-fix
Jul 10, 2024
Merged

Fix setting Datadog API key credentials with configuration as code#438
nikita-tkachenko-datadog merged 4 commits into
masterfrom
nikita-tkachenko/casc-fix

Conversation

@nikita-tkachenko-datadog

@nikita-tkachenko-datadog nikita-tkachenko-datadog commented Jul 10, 2024

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?

Fixes setting Datadog APU key credential ID with Configuration-as-Code Jenkins plugin.

Description of the Change

When configuring Datadog plugin with configuration as code, targetCredentialsApiKey field is set, but not the usedApiKey which refers to the actual API key used by the plugin (could be either the credential or the API key supplied in text input).

The workaround is to check whether the used key field is initialised when the plugin attempts to read it.
If the field is not initialised, both "target" fields are checked to see if the key was supplied using one of them.

This is a temporary workaround that will be removed later when the plugin configuration is refactored to have only one field for key.

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 marked this pull request as ready for review July 10, 2024 13:45
@nikita-tkachenko-datadog nikita-tkachenko-datadog added the changelog/Fixed Fixed features results into a bug fix version bump label Jul 10, 2024
Comment thread docker/docker-compose-casc.yaml Outdated
@@ -0,0 +1,9 @@
unclassified:

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.

nice!

@github-actions github-actions Bot added the documentation Documentation related changes label Jul 10, 2024
@nikita-tkachenko-datadog
nikita-tkachenko-datadog merged commit b7b7de4 into master Jul 10, 2024
@nikita-tkachenko-datadog
nikita-tkachenko-datadog deleted the nikita-tkachenko/casc-fix branch July 10, 2024 15:44
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 documentation Documentation related changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants