Continuous Integration Publish: 71ad377

Merge pull request #107 from cake-contrib/feature/GH-80

(GH-80) existing icons will be honored

Author: web-flow

feed.atom

@@ -4,5 +4,5 @@
 	<title>CakeContrib.Guidelines</title>
 	<link rel="self" href="https://cake-contrib.github.io/CakeContrib.Guidelines" />
 	<rights>2021</rights>
-	<updated>2021-03-03T19:50:40Z</updated>
+	<updated>2021-03-12T07:24:11Z</updated>
 </feed>

feed.rss

@@ -5,7 +5,7 @@
 		<link>https://cake-contrib.github.io/CakeContrib.Guidelines</link>
 		<description />
 		<copyright>2021</copyright>
-		<pubDate>Wed, 03 Mar 2021 19:50:40 GMT</pubDate>
-		<lastBuildDate>Wed, 03 Mar 2021 19:50:40 GMT</lastBuildDate>
+		<pubDate>Fri, 12 Mar 2021 07:24:11 GMT</pubDate>
+		<lastBuildDate>Fri, 12 Mar 2021 07:24:11 GMT</lastBuildDate>
 	</channel>
 </rss>

guidelines/CakeContribIcon.html

@@ -123,7 +123,6 @@ <h2 id="table-of-contents">Table of Contents</h2>
 <li><a href="#usage">Usage</a></li>
 <li><a href="#settings">Settings</a>
 <ul>
-<li><a href="#icon-location">Icon-Location</a></li>
 <li><a href="#icon-include-in-project">Icon include in project</a></li>
 </ul>
 </li>
@@ -146,44 +145,35 @@ <h2 id="usage">Usage</h2>
 <p>Using this package automatically enables this guideline.</p>
 <p>With no special settings at all (i.e. &quot;The Standard&quot;):</p>
 <ul>
-<li>the current cake-contrib icon will be copied as &quot;icon.png&quot; in the project-directory</li>
-<li>the icon will be included in the project</li>
+<li>if no <code>PackageIcon</code> property is specified, a default will be assigned.</li>
+<li>if no icon (matching the <code>PackageIcon</code> property) is referenced in the project, a default will be referenced.</li>
+<li>if the referenced icon is not binary equal to the default icon, it will be updated.</li>
+<li>if no <code>PackageIconUrl</code> property is specified, a default will be assigned.</li>
 </ul>
 <h2 id="settings">Settings</h2>
-<h3 id="icon-location">Icon-Location</h3>
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
-<p>The default location of the cake-contrib icon is <code>icon.png</code>, next to the csproj (i.e. <code>$(MSBuildProjectDirectory)/icon.png</code>).</p>
-<p>Setting <code>CakeContribGuidelinesIconDestinationLocation</code> makes it possible to override the default location of the Icon. For example setting</p>
-<pre><code class="language-xml">&lt;PropertyGroup&gt;
-    &lt;CakeContribGuidelinesIconDestinationLocation&gt;../logo.png&lt;/CakeContribGuidelinesIconDestinationLocation&gt;
-&lt;/PropertyGroup&gt;
-</code></pre>
-<p>in the csproj will place the icon as <code>logo.png</code> one folder up (relative to the current project).</p>
 <h3 id="icon-include-in-project">Icon include in project</h3>
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
-<p>The cake-contrib icon will be automatically included in the project, unless <code>CakeContribGuidelinesIconOmitImport</code> was defined.</p>
+<p>The cake-contrib icon will be automatically included in the project, unless
+<code>CakeContribGuidelinesIconOmitImport</code> is set to <code>True</code>.</p>
 <p>To to use a &quot;custom&quot; import the following could be used:</p>
 <pre><code class="language-xml">&lt;PropertyGroup&gt;
-    &lt;CakeContribGuidelinesIconOmitImport&gt;1&lt;/CakeContribGuidelinesIconOmitImport&gt;
+    &lt;CakeContribGuidelinesIconOmitImport&gt;True&lt;/CakeContribGuidelinesIconOmitImport&gt;
+    &lt;PackageIcon&gt;logo.png&lt;/PackageIcon&gt;
 &lt;/PropertyGroup&gt;
 &lt;ItemGroup&gt;
-    &lt;None Include=&quot;$(CakeContribGuidelinesIconDestinationLocation)&quot;&gt;
-        &lt;Pack&gt;True&lt;/Pack&gt;
-        &lt;PackagePath&gt;&lt;/PackagePath&gt;
-    &lt;/None&gt;
+    &lt;None Include=&quot;icons/logo.png&quot; Pack=&quot;True&quot; PackagePath=&quot;&quot; /&gt;
 &lt;/ItemGroup&gt; 
 </code></pre>
 <h2 id="migrating-from-an-existing-project">Migrating from an existing project</h2>
+<p>No steps are needed anymore. Existing settings will be detected and honored.</p>
+<p>Optionally:</p>
 <ul>
 <li>remove the existing icon</li>
 <li>remove the <code>Include</code> of the icon from the project-file</li>
-<li>add a reference to CakeContrib.Guidelines</li>
-<li>build the project</li>
-<li>set <code>PackageIcon</code> to <code>icon.png</code></li>
+<li>remove the <code>PackageIcon</code> from the project-file</li>
+<li>remove the <code>PackageIconUrl</code> from the project-file</li>
 </ul>
 
 	</section>

rules/ccg0001.html

@@ -127,12 +127,8 @@ <h2 id="description">Description</h2>
 <p>The guideline <a href="../guidelines/CakeContribIcon">CakeContrib-Icon</a> states, that the icon should be embedded.
 To that end, setting <code>PackageIcon</code> is required.</p>
 <h2 id="how-to-fix-violations">How to fix violations</h2>
-<p>Add</p>
-<pre><code class="language-xml">&lt;PropertyGroup&gt;
-    &lt;PackageIcon&gt;$(CakeContribGuidelinesIconDestinationLocation)&lt;/PackageIcon&gt;
-&lt;/PropertyGroup&gt;
-</code></pre>
-<p>to the project.</p>
+<p>This error will only show, if <code>CakeContribGuidelinesIconOmitImport</code> is <code>True</code> and no manual include of the icon was done.</p>
+<p>To fix this error, you need to remove the definition of <code>CakeContribGuidelinesIconOmitImport</code> or define a <code>PackageIcon</code> manually.</p>
 <h2 id="related-guidelines">Related guidelines</h2>
 <ul>
 <li><a href="../guidelines/CakeContribIcon">CakeContrib-Icon</a></li>

rules/ccg0003.html

@@ -109,7 +109,7 @@ <h1>CCG0003</h1>
 		</section>
 	<section class="content">
 		<blockquote class="blockquote">
-<p>PackageIcon points to wrong place</p>
+<p>The PackageIcon source (path/to/icon.jpeg) has an extension of jpeg. It can not be set from the CakeContrib-Icon.</p>
 </blockquote>
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
@@ -122,12 +122,21 @@ <h2 id="table-of-contents">Table of Contents</h2>
 </ul>
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 <h2 id="cause">Cause</h2>
-<p>This warning is raised, when <code>PackageIcon</code> does not point to the copied icon.
-(I.e. <code>PackageIcon</code> is not equal to <code>$(CakeContribGuidelinesIconDestinationLocation)</code>)</p>
+<p>This warning/error is raised, when the source of <code>PackageIcon</code> was outdated
+but could not be updated.</p>
 <h2 id="description">Description</h2>
-<p>Since the correct icon is copied to <code>$(CakeContribGuidelinesIconDestinationLocation)</code> it is expected, that this icon is packaged into the nupkg.</p>
+<p>The default package icon is a <code>png</code> and will be used to update outdated icons.
+If a different icon format than <code>png</code> is used, simply updating that icon with a
+<code>png</code> content will break the icon.</p>
+<p>If a <code>PackageIcon</code> is set, but no corresponding icon reference could be
+found, a reference should be added automatically. However, if <code>PackageIcon</code>
+is not set to a <code>png</code> file, such reference would not be possible.
+In this case <code>CCG0003</code> is an error and will break the build.</p>
+<p>If a <code>PackageIcon</code> is set with a corresponding icon reference but not to
+a <code>png</code> file, a test whether the icon is up-to-date is not possible.
+In this case <code>CCG0003</code> is a warning .</p>
 <h2 id="how-to-fix-violations">How to fix violations</h2>
-<p>Modify <code>PackageIcon</code> to point to the same place as <code>$(CakeContribGuidelinesIconDestinationLocation)</code>.</p>
+<p>Modify <code>PackageIcon</code> to point to a <code>png</code> file or remove the custom file entirely.</p>
 <h2 id="related-guidelines">Related guidelines</h2>
 <ul>
 <li><a href="../guidelines/CakeContribIcon">CakeContrib-Icon</a></li>

rules/index.html

@@ -127,7 +127,7 @@ <h1>Rules</h1>
 								<tr>
 									<td><strong><a href="/CakeContrib.Guidelines/rules/ccg0003">CCG0003</a></strong></td>
 									<td>
-PackageIcon points to wrong place									</td>
+PackageIcon can not be updated									</td>
 								</tr>
 								<tr>
 									<td><strong><a href="/CakeContrib.Guidelines/rules/ccg0004">CCG0004</a></strong></td>