You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The change in #3465 changed this to temp. This is wrong, and it makes the template comments confusing, because the temp folder should not be committed to git. The report file is written to both temp and etc on first run.
Hi all, just chiming in here because I stumbled on this in a new project I created. @mcdurdin is correct that the change made in #3465 is wrong and the PR should be rolled back.
The default value as specified in the defaults is "<projectFolder>/etc/", see in code here.
I suspect the confusion is coming from the fact that running api-extractor without the --local flag will only write the .api.md file to the reportTempFolder, which by default is "<projectFolder>/temp/". Including the --local flag will write the file to both folders. This behavior is described in the API report documentation, found here.
Summary
The default for reportFolder is
etc
:rushstack/apps/api-extractor/src/schemas/api-extractor-defaults.json
Line 20 in 8a33edf
The change in #3465 changed this to
temp
. This is wrong, and it makes the template comments confusing, because thetemp
folder should not be committed to git. The report file is written to both temp and etc on first run.Details
#3465 should be rolled back.
Standard questions
Please answer these questions to help us investigate your issue more quickly:
@microsoft/api-extractor
version?node -v
)?The text was updated successfully, but these errors were encountered: