Update pulumi-command shortcode to use local file #16072
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `pulumi-command` shortcode is used to emit an inline copy of the CLI's root command docs, which is referenced on a couple pages: - https://www.pulumi.com/docs/iac/cli/ - https://www.pulumi.com/docs/iac/cli/commands/ Originally, this shortcode simply opened the local file. Then when the docs were split between pulumi/docs and pulumi/pulumi-hugo repos, the shortcode was changed to make an API request to GitHub to grab the file's content from the docs repo. We've since merged these two repos back into the single pulumi/docs repo, so there's no longer a need to make a network request to get the content. We can go back to just reading the file. Which is what this change does.
|
Your site preview for commit ffd612b is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16072-ffd612bc.s3-website.us-west-2.amazonaws.com. |
PR ReviewThis change correctly simplifies the pulumi-command shortcode by removing the unnecessary GitHub API call and returning to local file reading. However, there's a path issue that needs to be fixed: Issues Found:
Suggested Fix: Replace line 1 with: {{- $content := readFile "content/docs/iac/cli/commands/pulumi.md" -}}The rest of the implementation looks good - the regex patterns for removing front matter and auto-generated suffixes are appropriate and match the original functionality. |
Claude suggests using `content/docs/iac/cli/commands/pulumi.md` rather than `/docs/iac/cli/commands/pulumi.md` (either work).
|
Your site preview for commit 36a4dea is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16072-36a4deab.s3-website.us-west-2.amazonaws.com. |
smithrobs
approved these changes
Sep 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
pulumi-commandshortcode is used to emit an inline copy of the CLI's root command docs, which is used on a couple pages:Originally, this shortcode simply opened the local file. Then when the docs were split between pulumi/docs and pulumi/pulumi-hugo repos, the shortcode was changed to make an API request to GitHub to grab the file's content from the docs repo.
We've since merged these two repos back into the single pulumi/docs repo, so there's no longer a need to make a network request to get the content. We can go back to just reading the file. Which is what this change does.
This should make site generation slightly faster and less flaky.