Skip to content

Documentation for using MSBuildTaskBase class#6760

Merged
missymessa merged 8 commits intomasterfrom
missymessa-6740
Jan 12, 2021
Merged

Documentation for using MSBuildTaskBase class#6760
missymessa merged 8 commits intomasterfrom
missymessa-6740

Conversation

@missymessa
Copy link
Copy Markdown
Member

Documentation to give instruction on best practices for using the MSBuildTaskBase class and how it works behind the scenes.

Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Copy link
Copy Markdown
Member

@MattGal MattGal left a comment

Choose a reason for hiding this comment

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

Good stuff. Does seem to assume the reader attended your brown bag.

Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Copy link
Copy Markdown

@ghost ghost left a comment

Choose a reason for hiding this comment

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

I like this! mostly nits, and perhaps some sections could benefit from some more context to be more helpful for first time readers.

Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
Comment thread Documentation/Mechanics/MSBuildTaskDependencyInjection.md Outdated
@missymessa
Copy link
Copy Markdown
Member Author

Good stuff. Does seem to assume the reader attended your brown bag.

Added the links from Chad's DI presentation for further reading about dependency injection.

@missymessa missymessa mentioned this pull request Jan 11, 2021
5 tasks
@missymessa
Copy link
Copy Markdown
Member Author

Whew. Okay, I think I got through everyone's feedback (thank you all!) and created another issue to add some enhancements to the base class (e.g. asyncing the ExecuteTask method; including default services where necessary; improving the logger so that we can use ILogger types). Also did a little bit of refactoring to the tests that I created to make better use of the DI testing functionality.

I'll merge this PR sometime tomorrow afternoon if there's no other feedback.

@missymessa missymessa merged commit 1aac190 into master Jan 12, 2021
@missymessa missymessa deleted the missymessa-6740 branch January 12, 2021 19:53
akoeplinger pushed a commit to akoeplinger/arcade that referenced this pull request Apr 12, 2021
* Documentation for using MSBuildTaskBase class

* Small changes per feedback

* Rewording opening paragraphs and clarifying implementation details

* Forgot to save

* Refactoring to the tests to use additionalScopedTypes and some doc changes

* Changed additionalScopeTypes to additionalSingleTypes; added link to code in base class in the documentation, since we can't embed code in docs :(
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants