Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: repair API doc generation by reverting replace-in-file dependency #4745

Merged
merged 1 commit into from
Dec 10, 2024

Conversation

pepopowitz
Copy link
Collaborator

Description

#4673 bumped replace-in-file to a version that is incompatible with our API generators! This PR reverts to a version that works.

Why did we bump to a version that didn't work?

Honestly, I have no idea why #4673 didn't fail when I tested it locally. It obviously won't work -- the release notes make it clear that it has been rewritten as an ES module, which our code can not run. I didn't read those notes when I tested locally, which I should have....but I definitely tested locally, and I guess I must not have run npm install when I did. I tried, I really did! 😭

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@pepopowitz pepopowitz self-assigned this Dec 10, 2024
@pepopowitz pepopowitz enabled auto-merge (squash) December 10, 2024 15:12
@pepopowitz pepopowitz merged commit 23f5dc8 into main Dec 10, 2024
11 checks passed
@pepopowitz pepopowitz deleted the pepopowitz/revert-replace-in-file branch December 10, 2024 15:28
@pepopowitz pepopowitz mentioned this pull request Dec 10, 2024
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants