Skip to content

Ensure docgen script restores original files even if build fails #7151

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Mar 28, 2023
Merged

Ensure docgen script restores original files even if build fails #7151

merged 2 commits into from
Mar 28, 2023

Conversation

hsubox76
Copy link
Contributor

Docgen modifies some files (usually packages/auth/api-extractor.json, but other files for TOC generation) before running yarn build and yarn api-report steps. If the process fails or is aborted during those steps, those files will remain modified, and any future runs will only restore them back to that modified state.

This PR uses a try/finally to make sure the files are always restored no matter what. Yes, you can have a try/finally without a catch: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/try...catch#description

Tested it in the cases of a yarn api-report failure and success and the files are restored properly in both cases.

@changeset-bot
Copy link

changeset-bot bot commented Mar 23, 2023

⚠️ No Changeset found

Latest commit: e414068

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@google-oss-bot
Copy link
Contributor

Size Report 1

Affected Products

No changes between base commit (480d7d5) and merge commit (d6df056).

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/9GJ6STHwNv.html

@hsubox76 hsubox76 marked this pull request as ready for review March 23, 2023 17:01
@hsubox76 hsubox76 requested a review from dwyfrequency as a code owner March 23, 2023 17:01
@google-oss-bot
Copy link
Contributor

Size Analysis Report 1

Affected Products

No changes between base commit (480d7d5) and merge commit (d6df056).

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/HGHd5YYbqU.html

dwyfrequency
dwyfrequency approved these changes Mar 23, 2023
View reviewed changes
Copy link
Contributor

@dwyfrequency dwyfrequency left a comment

Choose a reason for hiding this comment

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

LGTM

@hsubox76 hsubox76 merged commit 464e7a5 into master Mar 28, 2023
@hsubox76 hsubox76 deleted the ch-docgen-fix branch March 28, 2023 22:43
dwyfrequency pushed a commit that referenced this pull request Apr 13, 2023
@hsubox76 @dwyfrequency
Ensure docgen script restores original files even if build fails (#7151)
ef72742
@firebase firebase locked and limited conversation to collaborators Apr 28, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@dwyfrequency dwyfrequency dwyfrequency approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@hsubox76 @google-oss-bot @dwyfrequency