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

Failing on AppVeyor #1078

Closed
richardschneider opened this issue Dec 28, 2016 · 13 comments
Closed

Failing on AppVeyor #1078

richardschneider opened this issue Dec 28, 2016 · 13 comments

Comments

@richardschneider
Copy link
Contributor

@richardschneider richardschneider commented Dec 28, 2016

When building the documentation on AppVeyor, I get a warning. On my machine, there is no warning.

docfx metadata doc\docfx.json -f
Warning: Invalid cref value "!:System.String" found in triple-slash-comments for Decode defined in ../src/Base32.cs Line 66, ignored

The docfx.json has "xref": [ "msdn.4.5.2.zip" ]. And the zip file is in the repo.

@vwxyzh
Copy link
Contributor

@vwxyzh vwxyzh commented Dec 29, 2016

!:System.String that means Roslyn cannot find the string type, please make sure your environment can build code correctly.

@richardschneider
Copy link
Contributor Author

@richardschneider richardschneider commented Dec 29, 2016

@vwxyzh
Copy link
Contributor

@vwxyzh vwxyzh commented Dec 30, 2016

@qinezh any idea?
project is here

@qinezh
Copy link
Contributor

@qinezh qinezh commented Dec 30, 2016

From the description, it seems that there's something wrong within AppVeyor environment. Maybe you could try to modify some configuration in appveyor.yml, such as disable package cache, etc...

@richardschneider
Copy link
Contributor Author

@richardschneider richardschneider commented Dec 30, 2016

@qinezh I've just enabled package caching, after reporting the issue. All NuGet and choco packages and up to date. I also changed appyeyor.yml to use VS 2015. I'm using dotfx v2.9.3 from choco.

What config changes do you want me to make? I'm happy to try anything!

@richardschneider
Copy link
Contributor Author

@richardschneider richardschneider commented Dec 30, 2016

What are the requirements for docfx? Do I need a specific .Net framework? ...?

@qinezh
Copy link
Contributor

@qinezh qinezh commented Dec 30, 2016

.NET 452 is enough...

@richardschneider
Copy link
Contributor Author

@richardschneider richardschneider commented Dec 30, 2016

I changed the target framework version from 4.5 to 4.5.2 and still no love!

@cameronelliott
Copy link

@cameronelliott cameronelliott commented Jan 3, 2017

Richard, how did you resolve this?

@richardschneider
Copy link
Contributor Author

@richardschneider richardschneider commented Jan 3, 2017

No I haven't, I'm still getting invalid cref. I've tried numerous hacks with no luck so far.

I will take a look at what you did with LimeVideoSdk, tomorrow (I'm .UTC+1300) and see if it helps.

Your comment on #1097 is greatly appreciated.

@richardschneider
Copy link
Contributor Author

@richardschneider richardschneider commented Jan 8, 2017

I've been looking at Roslyn, and have determined that invalid cref of "!:System.String" is generated when the source is analysed and assembly references are not specified.

Could my problem be that the assembly references from the project are not being used? In particular mscorlib.

@richardschneider
Copy link
Contributor Author

@richardschneider richardschneider commented Jan 8, 2017

When running on appveyor the assembly references are MISSING!

I modified Microsoft.DocAsCode.Metadata.ManagedReference/ExtractMetadataWorker.GetProjectMetadataFromCacheAsync to display all the documentCache.GetDocuments. On my machine it displays the assembly references and the source files for the project. On appveyor it does NOT display the assembly references only the source files.

@vicancy @qinezh I need some help here. The whole generation of metadata and use of Roslyn is very complex and frankly I can't understand it. Hopefully I'v given you guys enough hints to find a fix.

@richardschneider
Copy link
Contributor Author

@richardschneider richardschneider commented Jan 11, 2017

The issue was solved by @vicancy

Do NOT use platform: Any CPU in appveyor.yml.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
5 participants
You can’t perform that action at this time.