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

[api-extractor] Fix wrongly documented default path for reportFolder #3465

Merged
merged 2 commits into from
Jun 15, 2022

Conversation

alirezamirian
Copy link
Contributor

.api.md file is generated in temp folder by default, not etc

Summary

.api.md file is generated in temp folder by default, not etc

Details

N/A

How it was tested

I just ran api-extractor with default configuration and it created the report file in temp folder.

@iclanton
Copy link
Member

Can you run rush change to generate a changelog file and commit that?

@iclanton iclanton added this to Waiting for Author in Bug Triage Jun 13, 2022
.api.md file is generated in `temp` folder by default, not `etc`
@ghost
Copy link

ghost commented Jun 13, 2022

CLA assistant check
All CLA requirements met.

@iclanton iclanton enabled auto-merge June 15, 2022 02:56
@iclanton iclanton merged commit 227d692 into microsoft:main Jun 15, 2022
Bug Triage automation moved this from Waiting for Author to Closed Jun 15, 2022
@mcdurdin
Copy link

mcdurdin commented Feb 26, 2024

This change seems incorrect. The default for reportFolder is etc:

"reportFolder": "<projectFolder>/etc/",

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.

I think this change should be rolled back.

(Note: made this into an issue in #4543)

@octogonz octogonz changed the title fix(template): fix wrongly documented default path for reportFolder [api-extractor] Fix wrongly documented default path for reportFolder Mar 1, 2024
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
Bug Triage
  
Closed
Development

Successfully merging this pull request may close these issues.

None yet

3 participants