Skip to content

Comments

docs: clarify Defender Deploy Environment API keys#107

Merged
CoveMB merged 3 commits intoOpenZeppelin:mainfrom
markopiers:docs/clarify-defender-deploy-api-keys
May 9, 2025
Merged

docs: clarify Defender Deploy Environment API keys#107
CoveMB merged 3 commits intoOpenZeppelin:mainfrom
markopiers:docs/clarify-defender-deploy-api-keys

Conversation

@markopiers
Copy link
Contributor

Description

This PR addresses the issue described in OpenZeppelin/openzeppelin-upgrades#996 by clarifying that the API keys referenced in the Defender integration documentation are specifically from the Production or Test Deploy Environment configured in Defender.

Changes made:

  • Added a note to foundry-defender.adoc explaining that the API keys are specifically from the Deploy Environment
  • Added a link to the Defender documentation's environment setup section for more information

Fixes

Motivation

Users were unclear about which API keys to use for Defender integration. This change makes it explicit that the keys should come from the Deploy Environment in Defender, reducing confusion and improving the developer experience.

@markopiers
Copy link
Contributor Author

markopiers commented May 8, 2025

@ericglau I've opened the pr as requested, please have a look
cc: @CoveMB

Co-authored-by: Eric Lau <ericglau@outlook.com>
@markopiers markopiers requested a review from ericglau May 8, 2025 16:50
Copy link
Member

@ericglau ericglau left a comment

Choose a reason for hiding this comment

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

Thanks

@ericglau ericglau requested a review from CoveMB May 8, 2025 16:52
Copy link
Contributor

@CoveMB CoveMB left a comment

Choose a reason for hiding this comment

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

Thanks for contributing ✨

Co-authored-by: Cove Marquis-Bortoli <44323490+CoveMB@users.noreply.github.com>
@markopiers
Copy link
Contributor Author

markopiers commented May 9, 2025

@CoveMB thanks for the review, I've added your suggestions. I think this can be merged now. If needed please squash merge it. Thanks.

@CoveMB CoveMB merged commit 9715e45 into OpenZeppelin:main May 9, 2025
4 checks passed
@markopiers markopiers deleted the docs/clarify-defender-deploy-api-keys branch May 9, 2025 22:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarify Defender integration docs for API keys

3 participants