Skip to content

docs: add warnings about client secret authentication in multiple mon… - #2043

Merged
SamErde merged 7 commits into
maester365:mainfrom
michaelmsonne:main
Jul 28, 2026
Merged

docs: add warnings about client secret authentication in multiple mon…#2043
SamErde merged 7 commits into
maester365:mainfrom
michaelmsonne:main

Conversation

@michaelmsonne

@michaelmsonne michaelmsonne commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

This pull request updates the documentation for all supported CI/CD platforms to include a warning about the risks of using client secret authentication for automation. The warning advises users to prefer workload identity federation over client secrets due to security and maintenance concerns.

Documentation updates to authentication guidance:

  • Added a warning in all relevant authentication sections (Azure DevOps, GitHub, GitLab, Bitbucket) to discourage the use of client secrets for long-term automation and recommend workload identity federation instead, highlighting the risks of expiration and manual rotation. [1] [2] [3] [4]
  • Updated the Create a client secret step-by-step guides to include the same warning for additional visibility.
  • Applied these changes to both the current and versioned (version-2.2.0) documentation to ensure consistency for all users.

📑 Description

Closes none - updates to docs only

✅ Checks

  • My pull request adheres to the code style of this project.
  • My code requires changes to the documentation.
  • I have updated the documentation as required.
  • The build and unit tests pass after running /powershell/tests/pester.ps1 locally.

ℹ️ Additional Information


How to Contribute

🏗️ Read our full contributing guide for the Maester project.
🧪 We also have additional instructions and a checklist for creating tests.

Join us at the Maester repository discussions or Entra Discord for more help and conversations!
While you wait for a review, why not spread some Maester love on social media? Thank you! 💖

Summary by CodeRabbit

  • Documentation
    • Added warnings to monitoring setup guides about the risks of using client secrets for long-term automation.
    • Clarified that client secrets expire, require manual rotation, and may require pipeline or repository variable updates.
    • Recommended workload identity federation as the preferred alternative when available.
    • Updated both current and versioned documentation.

@michaelmsonne
michaelmsonne requested a review from a team as a code owner July 28, 2026 12:53
@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Documentation now warns that client-secret authentication is unsuitable for long-term automation, noting expiration and manual rotation or variable updates, and recommends workload identity federation where possible across current and versioned guides.

Changes

Client Secret Guidance

Layer / File(s) Summary
Current documentation warnings
website/docs/monitoring/*.md, website/docs/sections/create-entra-client-secret.md
Warning admonitions were added to current monitoring guides and client-secret setup instructions.
Versioned documentation parity
website/versioned_docs/version-2.2.0/monitoring/*.md, website/versioned_docs/version-2.2.0/sections/create-entra-client-secret.md
Equivalent warnings were added to the version 2.2.0 documentation.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: merill

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title matches the docs change and clearly mentions warnings about client secret authentication.
Description check ✅ Passed The description follows the template well, includes the change summary, issue status, checklist, and additional information.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@website/docs/sections/create-entra-client-secret.md`:
- Around line 3-5: Replace the grammatically incorrect phrase in the shared
warning text with “we recommend using workload identity federation when
possible” across all listed documentation sites:
website/docs/sections/create-entra-client-secret.md lines 3-5;
website/docs/monitoring/azure-devops.md lines 259-261;
website/docs/monitoring/bitbucket.md lines 55-57;
website/docs/monitoring/github.md lines 257-259;
website/docs/monitoring/gitlab.md lines 271-273; and the corresponding versioned
files under website/versioned_docs/version-2.2.0 at the specified line ranges.
Keep the remainder of each warning unchanged.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 4bec6c31-c4f9-434d-a422-e428b8b57074

📥 Commits

Reviewing files that changed from the base of the PR and between 238894f and 96831b0.

📒 Files selected for processing (10)
  • website/docs/monitoring/azure-devops.md
  • website/docs/monitoring/bitbucket.md
  • website/docs/monitoring/github.md
  • website/docs/monitoring/gitlab.md
  • website/docs/sections/create-entra-client-secret.md
  • website/versioned_docs/version-2.2.0/monitoring/azure-devops.md
  • website/versioned_docs/version-2.2.0/monitoring/bitbucket.md
  • website/versioned_docs/version-2.2.0/monitoring/github.md
  • website/versioned_docs/version-2.2.0/monitoring/gitlab.md
  • website/versioned_docs/version-2.2.0/sections/create-entra-client-secret.md

Comment thread website/docs/sections/create-entra-client-secret.md
michaelmsonne and others added 3 commits July 28, 2026 15:00
Updated warning message for clarity and consistency.
Corrected the spelling of 'prefer' to 'preferred' in the warning section.

@SamErde SamErde left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Great addition! These just need a typo fixed (prefer --> preferred) and/or consider the suggested change from Code Rabbit AI.

@SamErde SamErde added the documentation Improvements or additions to documentation label Jul 28, 2026
Updates the repeated client-secret warning text across monitoring guides and shared section docs (including versioned 2.2.0 pages) to correct grammar and wording: replacing “it´s prefer” with “we recommend.” This keeps authentication guidance consistent and clearer.
Replace awkward phrasing with clearer recommendation language in the Azure DevOps docs.
@michaelmsonne

Copy link
Copy Markdown
Contributor Author

Thanks @SamErde - I feel it was a missing part 🤣

Should be there now.

@SamErde
SamErde merged commit 2da9a7b into maester365:main Jul 28, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants