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

Add default launchSettings.json #8935

Merged
merged 1 commit into from
Jul 5, 2023

Conversation

filzrev
Copy link
Contributor

@filzrev filzrev commented Jul 4, 2023

Purpose of this PR
This PR add default launchSettings.json to docfx project.

These change can make the following work easier.

  • Debugging docfx.exe project with default docs.
  • Debug docfx.exe project with custom target. (It need to modify docfx.json path in config)

Defined Profiles
Following profiles are defined.

Profile Name Description
docfx build (Default)
docfx metadata
docfx serve With --open-browser option
docfx

Usage
Launch profile's can be selected by Visual Studio navigation menu.
image

When docfx build profile selected. Ctrl+F5 starts docfx build command.
And docfx serve profile selected. Ctrl+F5 starts docfx serve --open-browser command.

Notes
launchSettings.json is excluded by project's .gitignore. and considered as per-user settings.
When this PR is merged. It may cause file conflicts if user already using custom launchSettings.json.
In that case. user needs to ignore updated content explicitly.

I thought this operation burden is acceptable.
Because project's default launchSettings.json is rarely changed from now on.
.

@codecov
Copy link

codecov bot commented Jul 4, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.01 ⚠️

Comparison is base (1263a81) 77.05% compared to head (7810a5e) 77.04%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #8935      +/-   ##
==========================================
- Coverage   77.05%   77.04%   -0.01%     
==========================================
  Files         605      605              
  Lines       25042    25042              
==========================================
- Hits        19295    19294       -1     
- Misses       5747     5748       +1     

see 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@yufeih yufeih added the engineering Makes the pull request to appear in the "Engineering" section of the next release note label Jul 5, 2023
@yufeih yufeih merged commit 43bda19 into dotnet:main Jul 5, 2023
@filzrev filzrev deleted the add-default-launch-profile branch July 5, 2023 01:48
p-kostov pushed a commit to ErpNetDocs/docfx that referenced this pull request Jun 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
engineering Makes the pull request to appear in the "Engineering" section of the next release note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants