cake-build / cake-build/website

Automation to make examples show pinned addin / tools directives

Open
#587 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
HTML
Stars
52
Forks
256
Avg merge
4h 42m
Merged PRs (30d)
8

Description

We get complaints from time to time from users which looked at XML code examples and copy/pasted the example into their buildscript without reading about the suggestion to pin addin and tool versions.

Some automated process would be nice to have examples always showing usage with latest version of the addin / tool. This would require to patch all documentation XML files before generating the API documentation and search for `#addin` and `#tool` usage there and replace it with the actual version of the specific addin or tool.

There are some points to consider though:

* An addin can contain `#addin` and `#tool` directives referencing a different NuGet package. Resolving needs to also work in this case.
* Examples don't necessary will work with latest version of a tool. In this case example should anyway mention specific version.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.