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.

Sign up for GitHub

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

Improve debugging feedback for plugin developpers #32

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve debugging feedback for plugin developpers #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions src/GitExtensions.Extensibility/build/GitExtensions.Extensibility.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<!-- The following properties may be overwritten by plugins. In case they are not defined, they assume default values. -->
<!-- The following properties may be overwritten by plugins (in `.csproj`, `.csproj.user` or `.props` files). In case they are not defined, they assume default values. -->
<PropertyGroup>
<GitExtensionsDownloadPath Condition="$(GitExtensionsDownloadPath) == ''">..\..\gitextensions.shared</GitExtensionsDownloadPath> <!-- path is relative to $(ProjectDir) -->
<GitExtensionsReferenceSource Condition="$(GitExtensionsReferenceSource) == ''">GitHub</GitExtensionsReferenceSource> <!-- 'GitHub' or 'AppVeyor' -->
<GitExtensionsReferenceVersion Condition="$(GitExtensionsReferenceVersion) == ''">latest</GitExtensionsReferenceVersion> <!-- 'latest' or 'v3.1' (= tag from GitHub releases) or 'v3.1.0.5877' (= build number from AppVeyor)-->
<GitExtensionsReferenceSource Condition="$(GitExtensionsReferenceSource) == ''">GitHub</GitExtensionsReferenceSource> <!-- 'GitHub' or 'AppYevor' -->
<GitExtensionsDownloadPath Condition="$(GitExtensionsDownloadPath) == ''">..\..\gitextensions.shared</GitExtensionsDownloadPath> <!-- path is relative to $(ProjectDir) -->
<GitExtensionsPath Condition="$(GitExtensionsPath) == ''">$([System.IO.Path]::Combine('$(ProjectDir)', '$(GitExtensionsDownloadPath)'))</GitExtensionsPath> <!-- for local builds (no download) -->
</PropertyGroup>

Expand All @@ -28,10 +28,16 @@
<!-- The prebuild event is available in VS projects referencing "GitExtensions.Extensibility". -->
<!-- It downloads $(GitExtensionsReferenceVersion) from $(GitExtensionsReferenceSource) and extracts it to $(GitExtensionsPath) -->
<Target Name="PreBuild" BeforeTargets="$(BuildDependsOn)">
<Message Text="Executing prebuild event provided by GitExtensions.Extensibility" />
<Message Text="Executing prebuild event provided by GitExtensions.Extensibility" Importance="high" />
<Message Text="[GitExtensions.Extensibility] Source: $(GitExtensionsReferenceSource)" Importance="high" />
<Message Text="[GitExtensions.Extensibility] Version: $(GitExtensionsReferenceVersion)" Importance="high" />
<Message Text="[GitExtensions.Extensibility] Download Path: $(GitExtensionsDownloadPath)" Importance="high" />
<Message Text="[GitExtensions.Extensibility] GitExtensions binaries path: $(GitExtensionsPath)" Importance="high" />
<Message Text="[GitExtensions.Extensibility Documentation] For overwrite and valid values, see: https://github.com/gitextensions/gitextensions.extensibility/blob/master/src/GitExtensions.Extensibility/build/GitExtensions.Extensibility.targets" Importance="high" />
Copy link
Member

Choose a reason for hiding this comment

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

"For overwrite and valid values" this bit is confusing... Could you please help me understand what this means?

Copy link
Member Author

Choose a reason for hiding this comment

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

The plugin developer could overwrite the values of these properties to target a specific version like it is done here:
https://github.com/gitextensions/GitExtensions.GerritPlugin/blob/master/src/GitExtensions.GerritPlugin/GitExtensions.GerritPlugin.csproj.user

For example to start migrating to a version not yet released (that's what I did to migrate the plugin I maintain).

The goal of this change is:

  1. don't loose time trying to find against which version of GitExtensions we are building
  2. easily know where is located the version downloaded (because from what I get, you have to delete the folder manually if you want to use another version)
  3. add this line of documentation to make easier for plugin developer how to change/overwrite the values and which one are valid


<MakeDir Directories="$(_GitExtensionsDownloadPath)" />
<Error Condition="!Exists($(GitExtensionsExecutablePath)) and !Exists($(_GitExtensionsDownloadScriptPath))" Text="Path to Git Extensions portable download script is wrong. Current value '$(_GitExtensionsDownloadScriptPath)'." />
<Exec Condition="!Exists($(GitExtensionsExecutablePath))" Command="powershell.exe -NoProfile -ExecutionPolicy Unrestricted $(_GitExtensionsDownloadScriptPath) -ExtractRootPath $(_GitExtensionsDownloadPath) -Version $(GitExtensionsReferenceVersion) -Source $(GitExtensionsReferenceSource)" />
<Message Text="Completed prebuild event provided by GitExtensions.Extensibility" />
<Message Text="Completed prebuild event provided by GitExtensions.Extensibility" Importance="high" />
Comment on lines 30 to +41
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<Target Name="PreBuild" BeforeTargets="$(BuildDependsOn)">
<Message Text="Executing prebuild event provided by GitExtensions.Extensibility" />
<Message Text="Executing prebuild event provided by GitExtensions.Extensibility" Importance="high" />
<Message Text="[GitExtensions.Extensibility] Source: $(GitExtensionsReferenceSource)" Importance="high" />
<Message Text="[GitExtensions.Extensibility] Version: $(GitExtensionsReferenceVersion)" Importance="high" />
<Message Text="[GitExtensions.Extensibility] Download Path: $(GitExtensionsDownloadPath)" Importance="high" />
<Message Text="[GitExtensions.Extensibility] GitExtensions binaries path: $(GitExtensionsPath)" Importance="high" />
<Message Text="[GitExtensions.Extensibility Documentation] For overwrite and valid values, see: https://github.com/gitextensions/gitextensions.extensibility/blob/master/src/GitExtensions.Extensibility/build/GitExtensions.Extensibility.targets" Importance="high" />
<MakeDir Directories="$(_GitExtensionsDownloadPath)" />
<Error Condition="!Exists($(GitExtensionsExecutablePath)) and !Exists($(_GitExtensionsDownloadScriptPath))" Text="Path to Git Extensions portable download script is wrong. Current value '$(_GitExtensionsDownloadScriptPath)'." />
<Exec Condition="!Exists($(GitExtensionsExecutablePath))" Command="powershell.exe -NoProfile -ExecutionPolicy Unrestricted $(_GitExtensionsDownloadScriptPath) -ExtractRootPath $(_GitExtensionsDownloadPath) -Version $(GitExtensionsReferenceVersion) -Source $(GitExtensionsReferenceSource)" />
<Message Text="Completed prebuild event provided by GitExtensions.Extensibility" />
<Message Text="Completed prebuild event provided by GitExtensions.Extensibility" Importance="high" />
<Target Name="PreBuild" BeforeTargets="$(BuildDependsOn)">
<Message Text="[GitExtensions.Extensibility] Refer to documentation for list of variables and supported values at https://github.com/gitextensions/gitextensions.extensibility/blob/master/src/GitExtensions.Extensibility/build/GitExtensions.Extensibility.targets" Importance="high" />
<Message Text="[GitExtensions.Extensibility] Executing prebuild event..." Importance="high" />
<Message Text="[GitExtensions.Extensibility] Source: $(GitExtensionsReferenceSource)" Importance="high" />
<Message Text="[GitExtensions.Extensibility] Version: $(GitExtensionsReferenceVersion)" Importance="high" />
<Message Text="[GitExtensions.Extensibility] Download path: $(GitExtensionsDownloadPath)" Importance="high" />
<Message Text="[GitExtensions.Extensibility] Binaries path: $(GitExtensionsPath)" Importance="high" />
<MakeDir Directories="$(_GitExtensionsDownloadPath)" />
<Error Condition="!Exists($(GitExtensionsExecutablePath)) and !Exists($(_GitExtensionsDownloadScriptPath))" Text="Path to Git Extensions portable download script is wrong. Current value '$(_GitExtensionsDownloadScriptPath)'." />
<Exec Condition="!Exists($(GitExtensionsExecutablePath))" Command="powershell.exe -NoProfile -ExecutionPolicy Unrestricted $(_GitExtensionsDownloadScriptPath) -ExtractRootPath $(_GitExtensionsDownloadPath) -Version $(GitExtensionsReferenceVersion) -Source $(GitExtensionsReferenceSource)" />
<Message Text="[GitExtensions.Extensibility] ...done!" Importance="high" />

</Target>
</Project>