Skip to content

docs: update Repository secrets references to PSGALLERY_API_KEY#26

Merged
tablackburn merged 1 commit into
mainfrom
docs/secret-name-rename
May 10, 2026
Merged

docs: update Repository secrets references to PSGALLERY_API_KEY#26
tablackburn merged 1 commit into
mainfrom
docs/secret-name-rename

Conversation

@tablackburn
Copy link
Copy Markdown
Owner

@tablackburn tablackburn commented May 10, 2026

Summary

  • Updates the README's "Repository secrets" table and surrounding paragraph to use PSGALLERY_API_KEY (the renamed secret).
  • Simplifies the previous "set the secret as PS_GALLERY_KEY but the env var is PSGALLERY_API_KEY" caveat now that the secret name matches what PowerShellBuild reads.
  • Adds a CHANGELOG entry under [Unreleased] / Changed documenting the rename and the migration steps for existing modules created from this template.

Context

This is the docs cleanup that follows the workflow-side rename in PR #25. The 5 consumer modules (JsmOperations, SrrDBAutomationToolkit, ReScenePS, PlexAutomationToolkit, ScheduledTasksManager) have all had their workflows + secrets rotated to the new name as well.

Test plan

  • CI passes (PSScriptAnalyzer Lint + Unit Tests×3 OS)

Verified 2026-05-10: PR head a2faf26 check-runs all green — PSScriptAnalyzer Lint, Unit Tests (ubuntu/macOS/windows-latest) all success.

  • Markdown still renders correctly on GitHub

Verified 2026-05-10: GitHub /readme HTML endpoint returns rendered markdown-body article for main; README.md content has 2× PSGALLERY_API_KEY refs and 0× PS_GALLERY_KEY refs; Repository secrets section (1221 chars) intact.

🤖 Generated with Claude Code

The README's Repository secrets table and explanation now use the renamed
secret name. Simplifies the previous "set the secret as PS_GALLERY_KEY but
the env var is PSGALLERY_API_KEY" caveat now that both names match.
Adds an Unreleased CHANGELOG entry under "Changed" with a migration note
for downstream modules.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 10, 2026 04:36
@tablackburn tablackburn enabled auto-merge (squash) May 10, 2026 04:36
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 10, 2026

Warning

Rate limit exceeded

@tablackburn has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 48 minutes and 39 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4a4a9ed8-66c0-4d14-8ae5-8941a0b7271f

📥 Commits

Reviewing files that changed from the base of the PR and between 0125a71 and a2faf26.

📒 Files selected for processing (2)
  • CHANGELOG.md
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/secret-name-rename

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 and usage tips.

@tablackburn tablackburn merged commit 117bcd4 into main May 10, 2026
13 checks passed
@tablackburn tablackburn deleted the docs/secret-name-rename branch May 10, 2026 04:36
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates template documentation to reflect the renamed PowerShell Gallery publish secret so that README guidance and changelog match the current GitHub Actions workflow configuration (introduced in PR #25).

Changes:

  • Renames the documented publish secret in the README “Repository secrets” section to PSGALLERY_API_KEY and removes the old mapping caveat.
  • Adds an [Unreleased] / Changed changelog entry describing the rename and migration steps for existing modules.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
README.md Updates the “Repository secrets” table and explanatory text to use PSGALLERY_API_KEY.
CHANGELOG.md Documents the secret rename and provides migration instructions under [Unreleased].

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

2 participants