Add a MonoDoc nuget package #246

mhutch · 2018-05-02T19:20:37Z

Fixes #228

Fixes mono#228

Therzok · 2018-05-04T07:38:13Z

Does this fix #227 ?

Otherwise, it won't work

mhutch · 2018-05-04T15:37:34Z

No, it doesn't

joelmartinez

Looks like there were a lot of changes in addition to just adding a nuget package ... and the build is failing, seems like a nuget reference issue.

@mhutch can you maybe give me a bit more details about what the intent was/is here? I would love to get this added and published on nuget

mhutch · 2018-05-25T21:19:33Z

Makefile

@@ -8,12 +8,11 @@ all: build
 build: $(MDOC)

 $(MDOC):
-	$(MSBUILD) apidoctools.sln /p:Configuration=$(CONFIGURATION);
+	$(MSBUILD) apidoctools.sln /r /p:Configuration=$(CONFIGURATION);


This does an MSBuild NuGet restore

mhutch · 2018-05-25T21:19:50Z

Makefile

@@ -26,6 +25,7 @@ check-mdoc:

 nuget:
 	nuget pack mdoc/mdoc.nuspec -outputdirectory bin/Nuget
+	$(MSBUILD) monodoc/monodoc.csproj /p:Configuration=$(CONFIGURATION) /t:Pack


This runs the MSBuild pack target

mhutch · 2018-05-25T21:20:04Z

Package.props

@@ -0,0 +1,11 @@
+<Project>


General package metadata

mhutch · 2018-05-25T21:20:28Z

apidoctools.sln

@@ -9,8 +9,6 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "monodoc", "monodoc\monodoc.
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Monodoc.Test", "monodoc\Test\Monodoc.Test.csproj", "{1EE70E2C-A289-4C36-AD0A-3D0C6CE56615}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ICSharpCode.SharpZipLib", "external\SharpZipLib\ICSharpCode.SharpZipLib.NET45\ICSharpCode.SharpZipLib.csproj", "{0E7413FF-EB9E-4714-ACF2-BE3A6A7B2FFD}"


Switched this to a NuGet reference so it could be a package dependency

mhutch · 2018-05-25T21:21:27Z

mdoc/mdoc.Test/CppCxFormatterMembersTests.cs

@@ -126,7 +126,7 @@ public void NoSupport_DefaultParameters()
            TestMethodSignature(CSharpTestLib, "Mono.DocTest.Widget", "Default", null);
        }

-        [TestFixtureTearDown]
+        [OneTimeTearDown]


Tracking NUnit API change

mhutch · 2018-05-25T21:21:55Z

mdoc/mdoc.Test/mdoc.Test.FSharp/mdoc.Test.FSharp.fsproj

-    <Reference Include="System.ValueTuple">
-      <HintPath>..\packages\System.ValueTuple.4.3.1\lib\netstandard1.0\System.ValueTuple.dll</HintPath>
-    </Reference>
+    <PackageReference Include="FSharp.Core" Version="4.3.4" />


Switched these to PackageReferences for consistency

mhutch · 2018-05-25T21:22:54Z

mdoc/mdoc.Test/mdoc.Test.csproj

@@ -7,7 +7,7 @@
    <OutputType>Library</OutputType>
    <RootNamespace>mdoc.Test</RootNamespace>
    <AssemblyName>mdoc.Test</AssemblyName>
-    <TargetFrameworkVersion>v4.6.1</TargetFrameworkVersion>
+    <TargetFrameworkVersion>v4.7.1</TargetFrameworkVersion>


Unlike 4.6.1, 4.7.1 doesn't require a pile of polyfill to be netstandard 2.0 compatible

mhutch · 2018-05-25T21:24:36Z

mdoc/mdoc.csproj

-    <Reference Include="Mono.Cecil.Rocks, Version=0.10.0.0, Culture=neutral, PublicKeyToken=50cebf1cceb9d05e, processorArchitecture=MSIL">
-      <HintPath>..\packages\Mono.Cecil.0.10.0-beta5\lib\net40\Mono.Cecil.Rocks.dll</HintPath>
-    </Reference>
+    <PackageReference Include="Mono.Cecil" Version="0.10.0" PrivateAssets="all" />


These are private so that they are local copied and mdoc works

mhutch · 2018-05-25T21:25:46Z

monodoc/Assembly/AssemblyInfo.cs

@@ -1,6 +0,0 @@
-using System.Reflection;


This file is autogenerated when using sdk style projects

mhutch · 2018-05-25T21:26:37Z

monodoc/Test/Monodoc.Test.csproj

@@ -1,59 +1,11 @@
-<?xml version="1.0" encoding="utf-8"?>
-<Project DefaultTargets="Build" ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+<Project Sdk="Microsoft.NET.Sdk">


SDK style projects are much nicer to hand edit :)

mhutch · 2018-05-25T21:27:09Z

monodoc/monodoc.csproj

@@ -1,713 +1,27 @@
-<?xml version="1.0" encoding="utf-8"?>
-<Project DefaultTargets="Build" ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+<Project Sdk="Microsoft.NET.Sdk">


Had to switch to SDK style to get netstandard 2.0 support and the MSBuild Pack target.

Also allows MASSIVELY simplifying the project file

mhutch · 2018-05-25T21:27:32Z

monodoc/monodoc.csproj

-  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
-    <Optimize>true</Optimize>
-    <OutputPath>..\bin\Release</OutputPath>
+    <TargetFramework>netstandard2.0</TargetFramework>


Yay netstandard 2.0!

mhutch · 2018-05-25T21:28:10Z

monodoc/monodoc.csproj

-    <Content Include="monodoc.dll.config">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </Content>
+    <PackageReference Include="SharpZipLib" Version="1.0.0-alpha2" />


One of the nice things about PackageReference is that the Pack target automatically converts it into a NuGet package dependency.

mhutch · 2018-05-25T21:29:35Z

monodoc/monodoc.csproj

-      <Name>ICSharpCode.SharpZipLib</Name>
-    </ProjectReference>
+    <Compile Include="..\external\Lucene.Net.Light\src\core\**\*.cs" Link="Lucene\%(Filename)%(Extension)" />
+    <Compile Remove="Mono.Utilities\MemoryLRU.cs" />


These files needed to be explicitly removed from the wildcard to match the old project's explicit file list

mhutch · 2018-05-25T21:31:32Z

monodoc/Monodoc/generators/html/Ecmaspec2Html.cs

@@ -10,7 +10,7 @@ namespace Monodoc.Generators.Html
 	public class Ecmaspec2Html : IHtmlExporter
 	{
 		static string css_ecmaspec;
-		static XslTransform ecma_transform;
+		static XslCompiledTransform ecma_transform;


Updating obsoleted API

mhutch · 2018-05-25T21:35:07Z

@joelmartinez I added a bunch of comments :)

mhutch · 2018-05-25T21:45:56Z

Currently failing with

 /usr/local/share/dotnet/sdk/2.1.200/Sdks/NuGet.Build.Tasks.Pack/build/NuGet.Build.Tasks.Pack.targets(198,5): warning : A stable release of a package should not have a prerelease dependency. Either modify the version spec of dependency "SharpZipLib [1.0.0-alpha2, )" or update the version field in the nuspec. [/Users/builder/jenkins/workspace/Docs-MonoApiDocTools/monodoc/monodoc.csproj]

joelmartinez · 2018-05-29T20:50:44Z

Ok, I took a look at this, and it seems like the newer version of nunit changed something about the way paths are resolved (maybe the default working directory, or something) ... so as a result, a bunch of tests that have to load some assemblies are failing.

I played around and got some of them passing by making this one change:

diff --git a/mdoc/mdoc.Test/BasicTests.cs b/mdoc/mdoc.Test/BasicTests.cs
index cddbcbd..ef136aa 100644
--- a/mdoc/mdoc.Test/BasicTests.cs
+++ b/mdoc/mdoc.Test/BasicTests.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.IO;
 using Mono.Cecil;
 
 namespace mdoc.Test
@@ -18,7 +19,10 @@ namespace mdoc.Test
 
             if (!moduleCash.ContainsKey(filepath))
             {
-                var readModule = ModuleDefinition.ReadModule(filepath);
+                var testAssemblyFilename = this.GetType ().Assembly.Modules.First().FullyQualifiedName;
+                var testDirectory = Path.GetDirectoryName (testAssemblyFilename);
+                var assemblyToOpenPath = Path.Combine (testDirectory, filepath);
+                var readModule = ModuleDefinition.ReadModule(assemblyToOpenPath);
                 moduleCash.Add(filepath, readModule);
             }

But there are still some other tests failing ... I've got to focus on putting a release together, so I'm probably not going to be able to look at this for another two weeks or so (given upcoming travel, etc).

Is there a way that maybe the scope of changes could be scaled back a bit? I fully understand and agree that SDK style projects are much nicer, but maybe that should be a standalone change/upgrade from the monodoc nuget? same for some of the other changes in this PR ...

mhutch · 2018-05-29T20:53:20Z

@joelmartinez the reason I migrated to SDK style projects was specifically because it makes it much easier to define/build the nuget packages though. I can't really separate them.

joelmartinez · 2018-05-29T20:57:23Z

@mhutch ok, fair enough ... then could it perhaps be decoupled from upgrading nunit (assuming that was the change that otherwise broke the unit tests)?

mhutch · 2018-05-29T21:06:11Z

@joelmartinez unfortunately nunit 2.6.4 doesn't support netstandard... :(

joelmartinez · 2018-05-29T21:35:39Z

@mhutch gotcha ... ok, I'll try to keep working on getting the unit tests passing here, but as I mentioned above, this will probably land after I'm able to get 5.7 out (ie. in a few weeks) :)

mhutch · 2018-05-29T22:08:42Z

fair enough!

kekyo · 2018-07-03T09:30:02Z

Ping: I'm waiting packaged monodoc :) what suspended reason?

joelmartinez · 2018-07-03T15:48:48Z

@kekyo It is on my agenda to revisit this soon ... no specific ETA, but it's definitely on the agenda. The PR needs some changes to ensure the unit tests still pass, not to mention some recent master changes that will have to be carefully merged

joelmartinez · 2018-07-09T19:32:00Z

I'm going to be breaking out some of these changes into separate/individual commits ... starting with updating to the latest nunit. This way I can make sure that all the unit tests continue passing as we subsequently move to SDK style projects, etc

Add a MonoDoc nuget package

ffa4dff

Fixes mono#228

mhutch mentioned this pull request May 3, 2018

[Build] Move some of the system dependencies into nugets mono/monodevelop#4434

Closed

joelmartinez requested changes May 25, 2018

View reviewed changes

mhutch commented May 25, 2018

View reviewed changes

Package.props

@@ -0,0 +1,11 @@

<Project>

Copy link

Member Author

mhutch May 25, 2018

Choose a reason for hiding this comment

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

General package metadata

mhutch commented May 25, 2018

View reviewed changes

Use a version of NUnit.Console that exists

ddbc447

mhutch added 3 commits May 25, 2018 17:46

Mark package as alpha for now

1bdb68c

Fix nunit runner path

45987c5

Fix nunit paths

05853d6

joelmartinez added enhancement do-not-merge labels May 29, 2018

This was referenced Jul 9, 2018

Update to latest nunit #284

Closed

Update to SDK Style projects #285

Open

joelmartinez mentioned this pull request Sep 18, 2018

Migrate public types into monodoc.dll #352

Open

Base automatically changed from master to main March 4, 2021 14:47

joelmartinez added the help wanted label Apr 12, 2021

MakiWolf mentioned this pull request Nov 26, 2023

Building on Windows dotdevelop/dotdevelop#136

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a MonoDoc nuget package #246

Add a MonoDoc nuget package #246

mhutch commented May 2, 2018

Therzok commented May 4, 2018

mhutch commented May 4, 2018

joelmartinez left a comment

mhutch May 25, 2018

mhutch May 25, 2018

mhutch May 25, 2018

mhutch May 25, 2018

mhutch May 25, 2018

mhutch May 25, 2018

mhutch May 25, 2018

mhutch May 25, 2018

mhutch May 25, 2018 •

edited

mhutch May 25, 2018

mhutch May 25, 2018

mhutch May 25, 2018

mhutch May 25, 2018

mhutch May 25, 2018

mhutch May 25, 2018

mhutch May 25, 2018

mhutch commented May 25, 2018

mhutch commented May 25, 2018

joelmartinez commented May 29, 2018

mhutch commented May 29, 2018

joelmartinez commented May 29, 2018

mhutch commented May 29, 2018

joelmartinez commented May 29, 2018

mhutch commented May 29, 2018

kekyo commented Jul 3, 2018

joelmartinez commented Jul 3, 2018

joelmartinez commented Jul 9, 2018

Add a MonoDoc nuget package #246

Are you sure you want to change the base?

Add a MonoDoc nuget package #246

Conversation

mhutch commented May 2, 2018

Therzok commented May 4, 2018

mhutch commented May 4, 2018

joelmartinez left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mhutch May 25, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mhutch commented May 25, 2018

mhutch commented May 25, 2018

joelmartinez commented May 29, 2018

mhutch commented May 29, 2018

joelmartinez commented May 29, 2018

mhutch commented May 29, 2018

joelmartinez commented May 29, 2018

mhutch commented May 29, 2018

kekyo commented Jul 3, 2018

joelmartinez commented Jul 3, 2018

joelmartinez commented Jul 9, 2018

mhutch May 25, 2018 •

edited