Skip to content

Commit 8949e3a

Browse files
CamSoperclaudegithub-actions[bot]
authored
Add comprehensive historical alias verification and fix 8 missing aliases (#16295)
* Add comprehensive historical alias verification scripts This adds a new set of scripts to verify ALL historical paths in git history have proper aliases, catching missing aliases that the branch-diff verification misses (pre-reorg moves, multi-hop moves, cross-branch moves). New scripts: - verify-all-historical-aliases.py: Scans complete git history (6 months) for all file moves, checks both frontmatter aliases and S3 redirects - generate-historical-fixes.py: Parses verification output and generates fix data in JSON format - apply-historical-fixes.py: Applies fixes by updating frontmatter aliases Updated README.md with comprehensive documentation of the new workflow, including when to use historical verification vs branch verification. Fixes missing aliases from pre-reorg moves that happened on master before the documentation reorganization branch was created. Related: #16292, #16119 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Add git similarity detection to catch low-similarity renames The original script missed files that were moved and significantly rewritten in the same commit (recorded as DELETE+ADD instead of RENAME). This updates the script to use git's -M30% flag, which detects renames even when files are only 30% similar. This now catches the missing OIDC files from the May 2024 documentation revamp where content was significantly changed during the move: - /docs/pulumi-cloud/access-management/oidc/provider/aws/ - /docs/pulumi-cloud/access-management/oidc/provider/azure/ - /docs/pulumi-cloud/access-management/oidc/provider/gcp/ - /docs/pulumi-cloud/access-management/oidc/provider/ (index) Results: - Before: 82 files with 82 missing aliases - After: 92 files with 93 missing aliases (+10 files, +11 aliases) Updated README to document the 30% similarity detection feature and why it's necessary for catching content revamps. Fixes #16292 (partially - provides tooling to detect the issue) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Fix false positives from development branch paths The script was checking ALL branches (--all flag) including development branches that were never merged to master. This caused 70% false positives from paths that only existed during development and were never published. Example: The CamSoper/content-reorg development branch had paths like /docs/get-started/iac/gcp/ which were restructured to /docs/iac/get-started/gcp/ before merging. These dev-only paths don't need aliases because no external links were ever created to them. Changed from `--all` to `origin/master` to only check published history. Results: - Before: 93 missing aliases (65 false positives from /docs/get-started/*) - After: 21 missing aliases (all legitimate) - 77% reduction in false positives The 21 remaining are real issues including the OIDC provider files from the May 2024 documentation revamp. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Add missing historical aliases for 8 files Applied fixes from the comprehensive historical alias verification, adding 8 missing aliases that the branch-diff verification missed: Key fixes: - OIDC provider files (AWS, Azure, GCP, index) from May 2024 documentation revamp where files were significantly rewritten (33-50% similarity) - OIDC client kubernetes-eks file - Developer portals templates file (including expected path that never existed) - Deployments post-automation and API reference files These were found using git's 30% similarity detection to catch low-similarity renames (files moved and significantly rewritten in the same commit). Also updated README.md to document the critical importance of reviewing generated fixes for false positives before committing, including common patterns to watch for and how to remove incorrect aliases. Note: The original report found 21 missing aliases, but 13 were false positives from similarity matching (Doppler/Infisical files, CLI command pseudo-renames, etc.) and were manually removed. Related: #16292, #16119 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Fix grammar error in meta_desc: 'Lean' -> 'Learn' Co-authored-by: Cam Soper <CamSoper@users.noreply.github.com> * Clarify prohibition on new files to specify that Markdown (.md) files must always end with a newline --------- Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Cam Soper <CamSoper@users.noreply.github.com>
1 parent a9adefa commit 8949e3a

File tree

14 files changed

+860
-34
lines changed

14 files changed

+860
-34
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,3 +84,7 @@ scripts/alias-verification/aliases-suspicious.txt
8484
scripts/alias-verification/deletes.txt
8585
scripts/alias-verification/renames.txt
8686
scripts/alias-verification/fixes-data.txt
87+
scripts/alias-verification/historical-aliases-correct.txt
88+
scripts/alias-verification/historical-aliases-missing.txt
89+
scripts/alias-verification/historical-aliases-report.txt
90+
scripts/alias-verification/historical-fixes.json

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Do not substitute other tools or commands.
4242
## Absolute Prohibitions
4343

4444
- **Package manager**: Do **not** change `package.json` to use pnpm. Yarn/npm only.
45-
- **New files**: Must always end with a newline.
45+
- **Markdown (.md) files**: Must always end with a newline.
4646

4747
---
4848

content/docs/administration/access-identity/oidc-client/kubernetes-eks.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,9 @@ menu:
1414
parent: openid-connect-client
1515
weight: 1
1616
aliases:
17-
- /docs/pulumi-cloud/oidc/client/kubernetes-eks/
18-
- /docs/pulumi-cloud/access-management/oidc-client/kubernetes-eks/
17+
- /docs/pulumi-cloud/access-management/oidc-client/kubernetes-eks/
18+
- /docs/pulumi-cloud/access-management/oidc/client/kubernetes-eks/
19+
- /docs/pulumi-cloud/oidc/client/kubernetes-eks/
1920
---
2021

2122
This document outlines the steps required to configure Pulumi to accept Elastic Kubernetes Service (EKS) id_tokens to be exchanged for a personal access token. With this configuration, Kubernetes pods authenticate to Pulumi Cloud using OIDC tokens issued by EKS.

content/docs/deployments/deployments/oidc/_index.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@ menu:
1111
weight: 60
1212
identifier: deployments-deployments-oidc
1313
aliases:
14-
- /docs/pulumi-cloud/oidc/
15-
- /docs/administration/access-identity/oidc/
16-
- /docs/pulumi-cloud/oidc/provider/
17-
- /docs/administration/access-identity/oidc/provider/
18-
- /docs/pulumi-cloud/deployments/oidc/
14+
- /docs/administration/access-identity/oidc/
15+
- /docs/administration/access-identity/oidc/provider/
16+
- /docs/pulumi-cloud/access-management/oidc/provider/
17+
- /docs/pulumi-cloud/deployments/oidc/
18+
- /docs/pulumi-cloud/oidc/
19+
- /docs/pulumi-cloud/oidc/provider/
1920
---
2021

2122
Pulumi Deployments supports OpenID Connect (OIDC) integration with popular cloud providers. In order for a Pulumi IaC operation like `update` or `preview` to work, the Pulumi CLI must be able to access credentials that will allow it to perform the necessary CRUD operations on the resources in your stack. Pulumi Deployments' OIDC integrations allow your your deployments to use dynamic, short-lived cloud credentials for supported clouds instead of static credentials which are less secure and difficult to rotate. This page explains how to set up OIDC for Pulumi Deployments to access resources in your cloud provider accounts.

content/docs/deployments/deployments/oidc/aws.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,14 @@ menu:
1111
weight: 1
1212
identifier: deployments-deployments-oidc-aws
1313
aliases:
14-
- /docs/pulumi-cloud/deployments/oidc/aws/
15-
- /docs/guides/oidc/provider/aws
16-
- /docs/intro/deployments/oidc/provider/aws/
17-
- /docs/pulumi-cloud/deployments/oidc/provider/aws/
18-
- /docs/pulumi-cloud/oidc/provider/aws/
19-
- /docs/pulumi-cloud/oidc/aws/
20-
- /docs/administration/access-identity/oidc/provider/aws/
14+
- /docs/administration/access-identity/oidc/provider/aws/
15+
- /docs/guides/oidc/provider/aws
16+
- /docs/intro/deployments/oidc/provider/aws/
17+
- /docs/pulumi-cloud/access-management/oidc/provider/aws/
18+
- /docs/pulumi-cloud/deployments/oidc/aws/
19+
- /docs/pulumi-cloud/deployments/oidc/provider/aws/
20+
- /docs/pulumi-cloud/oidc/aws/
21+
- /docs/pulumi-cloud/oidc/provider/aws/
2122
---
2223

2324
{{% notes type="info" %}}

content/docs/deployments/deployments/oidc/azure.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,14 @@ menu:
1111
weight: 2
1212
identifier: deployments-deployments-oidc-azure
1313
aliases:
14-
- /docs/pulumi-cloud/deployments/oidc/azure/
15-
- /docs/guides/oidc/provider/azure
16-
- /docs/intro/deployments/oidc/provider/azure/
17-
- /docs/pulumi-cloud/deployments/oidc/provider/azure/
18-
- /docs/pulumi-cloud/oidc/provider/azure/
19-
- /docs/pulumi-cloud/oidc/azure/
20-
- /docs/administration/access-identity/oidc/provider/azure/
14+
- /docs/administration/access-identity/oidc/provider/azure/
15+
- /docs/guides/oidc/provider/azure
16+
- /docs/intro/deployments/oidc/provider/azure/
17+
- /docs/pulumi-cloud/access-management/oidc/provider/azure/
18+
- /docs/pulumi-cloud/deployments/oidc/azure/
19+
- /docs/pulumi-cloud/deployments/oidc/provider/azure/
20+
- /docs/pulumi-cloud/oidc/azure/
21+
- /docs/pulumi-cloud/oidc/provider/azure/
2122
---
2223

2324
{{% notes type="info" %}}

content/docs/deployments/deployments/oidc/gcp.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,14 @@ menu:
1111
weight: 3
1212
identifier: deployments-deployments-oidc-gcp
1313
aliases:
14-
- /docs/pulumi-cloud/deployments/oidc/gcp/
15-
- /docs/guides/oidc/provider/gcp
16-
- /docs/intro/deployments/oidc/provider/gcp/
17-
- /docs/pulumi-cloud/deployments/oidc/provider/gcp/
18-
- /docs/pulumi-cloud/oidc/provider/gcp/
19-
- /docs/pulumi-cloud/oidc/gcp/
20-
- /docs/administration/access-identity/oidc/provider/gcp/
14+
- /docs/administration/access-identity/oidc/provider/gcp/
15+
- /docs/guides/oidc/provider/gcp
16+
- /docs/intro/deployments/oidc/provider/gcp/
17+
- /docs/pulumi-cloud/access-management/oidc/provider/gcp/
18+
- /docs/pulumi-cloud/deployments/oidc/gcp/
19+
- /docs/pulumi-cloud/deployments/oidc/provider/gcp/
20+
- /docs/pulumi-cloud/oidc/gcp/
21+
- /docs/pulumi-cloud/oidc/provider/gcp/
2122
---
2223

2324
{{% notes type="info" %}}

content/docs/deployments/deployments/using/post-automation.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ title: "Post-Deployment Automation"
55
h1: "Post-Deployment Automation"
66
meta_image: /images/docs/meta-images/docs-meta.png
77
aliases:
8-
- /docs/pulumi-cloud/deployments/using/post-automation/
8+
- /docs/pulumi-cloud/deployments/reference/
9+
- /docs/pulumi-cloud/deployments/using/post-automation/
910
menu:
1011
deployments:
1112
parent: deployments-deployments-using

content/docs/idp/developer-portals/templates/_index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Organization templates
33
title_tag: Get started with organization templates
44
h1: Building developer portals with organization templates
5-
meta_desc: Lean how to build template projects and configure them to work with your Pulumi organization.
5+
meta_desc: Learn how to build template projects and configure them to work with your Pulumi organization.
66
menu:
77
idp:
88
name: Organization templates
@@ -12,6 +12,7 @@ menu:
1212
aliases:
1313
- /docs/idp/developer-portals/templates/
1414
- /docs/pulumi-cloud/developer-platforms/templates/
15+
- /docs/pulumi-cloud/developer-portals/templates/
1516
---
1617

1718
{{% notes "info" %}}

content/docs/reference/cloud-rest-api/deployments/_index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,15 @@ menu:
77
parent: cloud-rest-api
88
weight: 4.5
99
aliases:
10-
- /docs/reference/cloud-rest-api/deployments/
1110
- /docs/deployments/deployments/api
1211
- /docs/deployments/deployments/api/
13-
- /docs/reference/deployments-rest-api
14-
- /docs/reference/deployments-rest-api/
1512
- /docs/intro/deployments/api
1613
- /docs/intro/deployments/api/
14+
- /docs/pulumi-cloud/deployments/api/
1715
- /docs/pulumi-cloud/reference/deployments/
16+
- /docs/reference/cloud-rest-api/deployments/
17+
- /docs/reference/deployments-rest-api
18+
- /docs/reference/deployments-rest-api/
1819
---
1920

2021
The Deployments API allows you to configure and manage Pulumi Deployments, which enable you to execute Pulumi updates and other operations through the Pulumi Cloud. With this API, you can configure deployment settings for your stacks, trigger deployments, view deployment status and logs, and manage deployment execution.

0 commit comments

Comments
 (0)