Continuous Integration Publish: 609bf32

Merge pull request #972 from nils-a/feature/GH-510

(#510) post to mastodon on successful publishing

docs/fundamentals/environment-variables.html

@@ -283,6 +283,15 @@ <h3 id="email_username">EMAIL_USERNAME</h3>
 <p>The username that should be used for authenticating to the SMTP server.</p>
 <h3 id="email_password">EMAIL_PASSWORD</h3>
 <p>The password that should be used for authenticating to the SMTP server.</p>
+<h2 id="mastodon">Mastodon</h2>
+<p>When a successful release build has been completed, Cake.Recipe can be configured to send out a notification (with configurable message) to the fediverse via Mastodon. There are two required environment variables that needs to be set to make this happen.  Further information about find this information can be found in the Cake.Mastodon <a href="https://github.com/cake-contrib/Cake.Mastodon/blob/master/README.md#usage">documentation</a>.</p>
+<div class="alert alert-info"><p><strong>NOTE:</strong></p>
+<p>In addition to these environment variables being present, and correct, the control variable <a href="./set-parameters#shouldPostToMastodon">shouldPostToMastodon</a> also needs to be set to true.  The default value for this parameter is true.</p>
+</div>
+<h3 id="mastodon_access_token">MASTODON_ACCESS_TOKEN</h3>
+<p>The Access Token for the Mastodon application that is going to be used to send the toot.</p>
+<h3 id="mastodon_instance_url">MASTODON_INSTANCE_URL</h3>
+<p>The URL to the Mastodon instance, where the application was registered.</p>
 <h2 id="appveyor">AppVeyor</h2>
 <p>More information about what this is used for can be found in the <a href="../usage/cleaning-cache">clean AppVeyor build cache</a> documentation.</p>
 <div class="alert alert-info"><p><strong>NOTE:</strong></p>

docs/fundamentals/set-parameters.html

@@ -341,6 +341,12 @@ <h3 id="shouldsendemail">shouldSendEmail</h3>
 <p>Default Value:</p>
 <pre><code class="language-csharp">true
 </code></pre>
+<h3 id="shouldposttomastodon">shouldPostToMastodon</h3>
+<p>This is used as a final control variable for whether or not notification messages should be posted to the fediverse via Mastodon when the a final release build (i.e. a tagged build) completes.</p>
+<p>Type: <code>bool</code></p>
+<p>Default Value:</p>
+<pre><code class="language-csharp">true
+</code></pre>
 <h3 id="shoulddownloadmilestonereleasenotes">shouldDownloadMilestoneReleaseNotes</h3>
 <p>When executing the <code>Export-Release-Notes</code> task, this variable controls whether or not the release notes for the current milestone is exported by GitReleaseManager.</p>
 <p>Type: <code>bool</code></p>
@@ -486,6 +492,12 @@ <h3 id="twittermessage">twitterMessage</h3>
 <p>Default Value:</p>
 <pre><code class="language-csharp">Version {0} of the {1} Addin has just been released, this will be available here https://www.nuget.org/packages/{1}, once package indexing is complete.&quot;
 </code></pre>
+<h3 id="mastodonmessage">mastodonMessage</h3>
+<p>This is the message that is sent to the fediverse via Mastodon at the end of a tagged build.  This is formatted with the calculated version number, as well as the Title parameter.</p>
+<p>Type: <code>string</code></p>
+<p>Default Value:</p>
+<pre><code class="language-csharp">Version {0} of the {1} Addin has just been released, this will be available here https://www.nuget.org/packages/{1}, once package indexing is complete.&quot;
+</code></pre>
 <h3 id="wyamrootdirectorypath">wyamRootDirectoryPath</h3>
 <p>This is the directory that stores the documentation files that will be passed to the Wyam tool.</p>
 <p>Type: <code>DirectoryPath</code></p>

docs/fundamentals/set-variable-names.html

@@ -263,6 +263,10 @@ <h3 id="emailusername">emailUserName</h3>
 <p>Default value: <code>EMAIL_USERNAME</code></p>
 <h3 id="emailpassword">emailPassword</h3>
 <p>Default value: <code>EMAIL_PASSWORD</code></p>
+<h3 id="mastodonaccesstokenvariable">mastodonAccessTokenVariable</h3>
+<p>Default value: <code>MASTODON_ACCESS_TOKEN</code></p>
+<h3 id="mastodoninstanceurlvariable">mastodonInstanceUrlVariable</h3>
+<p>Default value: <code>MASTODON_INSTANCE_URL</code></p>
 <h3 id="appveyorapitokenvariable">appVeyorApiTokenVariable</h3>
 <p>Default value: <code>APPVEYOR_API_TOKEN</code></p>
 <h3 id="codecovrepotokenvariable">codecovRepoTokenVariable</h3>

feed.atom

@@ -4,5 +4,5 @@
 	<title>Cake.Recipe</title>
 	<link rel="self" href="http://cake-contrib.github.io/Cake.Recipe" />
 	<rights>2024</rights>
-	<updated>2024-08-01T20:27:29Z</updated>
+	<updated>2024-08-01T20:38:25Z</updated>
 </feed>

feed.rss

@@ -5,7 +5,7 @@
 		<link>http://cake-contrib.github.io/Cake.Recipe</link>
 		<description />
 		<copyright>2024</copyright>
-		<pubDate>Thu, 01 Aug 2024 20:27:29 GMT</pubDate>
-		<lastBuildDate>Thu, 01 Aug 2024 20:27:29 GMT</lastBuildDate>
+		<pubDate>Thu, 01 Aug 2024 20:38:25 GMT</pubDate>
+		<lastBuildDate>Thu, 01 Aug 2024 20:38:25 GMT</lastBuildDate>
 	</channel>
 </rss>