Skip to content

chore: use github app token for beachball release - #36634

Merged
Elizabeth Craig (ecraig12345) merged 3 commits into
masterfrom
user/elcraig/github-app-auth
Aug 27, 2026
Merged

chore: use github app token for beachball release#36634
Elizabeth Craig (ecraig12345) merged 3 commits into
masterfrom
user/elcraig/github-app-auth

Conversation

@ecraig12345

@ecraig12345 Elizabeth Craig (ecraig12345) commented Aug 26, 2026

Copy link
Copy Markdown
Member

As a temporary measure until #36626 is ready, apply only the changes to release with the office-ogx-auth-helper GitHub app's token. There's a temporary template .devops/templates/run-with-token.yml which handles getting and revoking the token, and takes steps to run inside as a parameter.

To validate that creating the token works, I ran the pipeline against this branch. All branch rules have been updated to allow the app to bypass.

Also update scripts/beachball/src/customRenderers.ts and update-release-notes to use new token variables, and to cache the fetched PRs by commit, which should make the release process faster.

@github-actions github-actions Bot added the CI label Aug 26, 2026
@github-actions

Copy link
Copy Markdown

📊 Bundle size report

✅ No changes found

@github-actions

Copy link
Copy Markdown

Pull request demo site: URL

@ecraig12345
Elizabeth Craig (ecraig12345) force-pushed the user/elcraig/github-app-auth branch 2 times, most recently from 782b0e4 to 08cc663 Compare August 26, 2026 04:29
@ecraig12345
Elizabeth Craig (ecraig12345) marked this pull request as ready for review August 26, 2026 04:29
@ecraig12345
Elizabeth Craig (ecraig12345) requested a review from a team as a code owner August 26, 2026 04:29

Copilot AI 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.

Pull request overview

Migrates release pipelines from a PAT to a temporary GitHub App token and optimizes release-note PR lookups.

Changes:

  • Adds token creation/revocation around publishing.
  • Adopts Beachball v3 token variables.
  • Adds commit-based PR caching, though the Beachball renderer cache currently uses object identity.

Merge confidence: 68/100 — token permissions and renderer caching require correction.

Reviewed changes

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

Show a summary per file
File Description
.devops/templates/run-with-token.yml Creates and revokes the app token.
.devops/templates/tools.yml Configures the app’s Git identity.
.vscode/launch.json Supplies the release-note token via environment.
azure-pipelines.release.yml Updates v8 publishing and release notes.
azure-pipelines.release.web-components.yml Updates Web Components publishing.
azure-pipelines.release.tools.yml Updates tools publishing.
azure-pipelines.release.tools-experimental.yml Renames the npm token variable.
azure-pipelines.release.headless.yml Updates headless publishing.
azure-pipelines.release-headless-experimental.yml Renames the npm token variable.
azure-pipelines.release-vnext.yml Updates v9 publishing.
azure-pipelines.release-vnext-experimental.yml Renames the npm token variable.
azure-pipelines.release-vnext-nightly.yml Renames the npm token variable.
scripts/beachball/src/customRenderers.ts Uses the app token and adds PR caching.
scripts/beachball/src/shared.config.ts Updates Beachball token documentation.
scripts/update-release-notes/src/init.ts Reads GitHub authentication from TOKEN.
scripts/update-release-notes/src/pullRequests.ts Caches PR results by commit.
Suppressed comments (1)

scripts/beachball/src/customRenderers.ts:14

  • This variable now contains a GitHub App installation token, not a personal access token. Keeping the githubPAT name makes the authentication source misleading; rename it to githubToken (including its warning check and Octokit initialization).
const githubPAT = process.env.BEACHBALL_GIT_TOKEN;
if (!githubPAT && (process.argv.includes('bump') || process.argv.includes('publish'))) {
  console.warn('\nBEACHBALL_GIT_TOKEN environment variable not found. GitHub requests may be rate-limited.\n');
}

const github = new Octokit({
  ...fluentRepoDetails,
  ...(githubPAT && { auth: 'token ' + githubPAT }),

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .devops/templates/run-with-token.yml Outdated
Comment thread scripts/beachball/src/customRenderers.ts Outdated
Comment thread .devops/templates/run-with-token.yml Outdated
Comment thread scripts/beachball/src/customRenderers.ts Outdated
Comment thread scripts/beachball/src/customRenderers.ts Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@ecraig12345
Elizabeth Craig (ecraig12345) merged commit 87140d5 into master Aug 27, 2026
16 checks passed
@ecraig12345
Elizabeth Craig (ecraig12345) deleted the user/elcraig/github-app-auth branch August 27, 2026 06:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants