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

Refine service reference warnings and errors #13184

Merged
merged 1 commit into from
Aug 16, 2019

Conversation

dougbu
Copy link
Member

@dougbu dougbu commented Aug 16, 2019

  • Refine warnings and errors in service ref feature #12792
  • client:
    • add error if OpenAPI file does not exist
    • separate unsupported TFM case from targets being called when disabled
  • server:
    • generalize multi-targeting handling in Microsoft.Extensions.ApiDescription.Server
      • add $(_OpenApiGenerateDocumentsTFM), the TFM used when invoking inner build
      • default $(OpenApiGenerateDocuments) to 'true' only when a supported TFM exists
    • add separate error for non-existent cache file in OpenApiGetDocuments target
    • add error in GetDocumentInsider if no documents are found
      • make <Warning /> in the targets file an <Error />
      • add more text to existing ServiceNotFound error
  • both:
    • write errors to stderr
    • clean up top-level output for Exceptions
      • stop writing the Message twice
  • Correct "Open API" mentions; should be "OpenAPI"

    • change package tags and comments
  • Add service reference projects to MvcNoDeps.slnf

nits:

  • add "service reference" tag in Microsoft.Extensions.ApiDescription.* packages
  • add "document generation" tag in Microsoft.Extensions.ApiDescription.Server package
  • .Trim() TFM properties because <TargetFrameworks>;netcoreapp3.0;;</TargetFrameworks> is allowed
  • don't use bold black for verbose messages
  • reorder MSBuild property settings for readability

- #12792
- client:
  - add error if OpenAPI file does not exist
  - separate unsupported TFM case from targets being called when disabled
- server:
  - generalize multi-targeting handling in Microsoft.Extensions.ApiDescription.Server
    - add `$(_OpenApiGenerateDocumentsTFM)`, the TFM used when invoking inner build
    - default `$(OpenApiGenerateDocuments)` to 'true' only when a supported TFM exists
  - add separate error for non-existent cache file in `OpenApiGetDocuments` target
  - add error in `GetDocumentInsider` if no documents are found
    - make `<Warning />` in the targets file an `<Error />`
    - add more text to existing `ServiceNotFound` error
- both:
  - write errors to `stderr`
  - clean up top-level output for `Exception`s
    - stop writing the `Message` twice

* Correct "Open API" mentions; should be "OpenAPI"
  - change package tags and comments

* Add service reference projects to MvcNoDeps.slnf

nits:
- add "service reference" tag in Microsoft.Extensions.ApiDescription.* packages
- add "document generation" tag in Microsoft.Extensions.ApiDescription.Server package
- `.Trim()` TFM properties because `<TargetFrameworks>;netcoreapp3.0;;</TargetFrameworks>` is allowed
- don't use bold black for verbose messages
- reorder MSBuild property settings for readability
@dougbu
Copy link
Member Author

dougbu commented Aug 16, 2019

/bump reviewers. All checks passed.

@dougbu
Copy link
Member Author

dougbu commented Aug 16, 2019

@pranavkm @rynowak please have a look

@dougbu dougbu merged commit c0d5248 into release/3.0 Aug 16, 2019
@ghost ghost deleted the dougbu/service.ref.warnings.12792 branch August 16, 2019 23:56
@dougbu dougbu added the tell-mode Indicates a PR which is being merged during tell-mode label Aug 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tell-mode Indicates a PR which is being merged during tell-mode
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants