From c3cdceb14347a1f397b7aba9ffc2fb3c5d76dbca Mon Sep 17 00:00:00 2001 From: GitHub Date: Thu, 1 Aug 2024 20:38:49 +0000 Subject: [PATCH] Continuous Integration Publish: 609bf32ef1a9de5f4b1714eb4e285b4a2bf76c27 Merge pull request #972 from nils-a/feature/GH-510 (#510) post to mastodon on successful publishing --- docs/fundamentals/environment-variables.html | 9 +++++++++ docs/fundamentals/set-parameters.html | 12 ++++++++++++ docs/fundamentals/set-variable-names.html | 4 ++++ feed.atom | 2 +- feed.rss | 4 ++-- 5 files changed, 28 insertions(+), 3 deletions(-) diff --git a/docs/fundamentals/environment-variables.html b/docs/fundamentals/environment-variables.html index 62750fb1..212500ec 100644 --- a/docs/fundamentals/environment-variables.html +++ b/docs/fundamentals/environment-variables.html @@ -283,6 +283,15 @@

EMAIL_USERNAME

The username that should be used for authenticating to the SMTP server.

EMAIL_PASSWORD

The password that should be used for authenticating to the SMTP server.

+

Mastodon

+

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 documentation.

+

NOTE:

+

In addition to these environment variables being present, and correct, the control variable shouldPostToMastodon also needs to be set to true. The default value for this parameter is true.

+
+

MASTODON_ACCESS_TOKEN

+

The Access Token for the Mastodon application that is going to be used to send the toot.

+

MASTODON_INSTANCE_URL

+

The URL to the Mastodon instance, where the application was registered.

AppVeyor

More information about what this is used for can be found in the clean AppVeyor build cache documentation.

NOTE:

diff --git a/docs/fundamentals/set-parameters.html b/docs/fundamentals/set-parameters.html index 40cab36a..d24b938b 100644 --- a/docs/fundamentals/set-parameters.html +++ b/docs/fundamentals/set-parameters.html @@ -341,6 +341,12 @@

shouldSendEmail

Default Value:

true
+

shouldPostToMastodon

+

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.

+

Type: bool

+

Default Value:

+
true
+

shouldDownloadMilestoneReleaseNotes

When executing the Export-Release-Notes task, this variable controls whether or not the release notes for the current milestone is exported by GitReleaseManager.

Type: bool

@@ -486,6 +492,12 @@

twitterMessage

Default Value:

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."
+

mastodonMessage

+

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.

+

Type: string

+

Default Value:

+
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."
+

wyamRootDirectoryPath

This is the directory that stores the documentation files that will be passed to the Wyam tool.

Type: DirectoryPath

diff --git a/docs/fundamentals/set-variable-names.html b/docs/fundamentals/set-variable-names.html index 0212f75e..ce6198ec 100644 --- a/docs/fundamentals/set-variable-names.html +++ b/docs/fundamentals/set-variable-names.html @@ -263,6 +263,10 @@

emailUserName

Default value: EMAIL_USERNAME

emailPassword

Default value: EMAIL_PASSWORD

+

mastodonAccessTokenVariable

+

Default value: MASTODON_ACCESS_TOKEN

+

mastodonInstanceUrlVariable

+

Default value: MASTODON_INSTANCE_URL

appVeyorApiTokenVariable

Default value: APPVEYOR_API_TOKEN

codecovRepoTokenVariable

diff --git a/feed.atom b/feed.atom index 9ae91bef..34f4249f 100644 --- a/feed.atom +++ b/feed.atom @@ -4,5 +4,5 @@ Cake.Recipe 2024 - 2024-08-01T20:27:29Z + 2024-08-01T20:38:25Z \ No newline at end of file diff --git a/feed.rss b/feed.rss index 2bb0c1b7..a5e6d0ef 100644 --- a/feed.rss +++ b/feed.rss @@ -5,7 +5,7 @@ http://cake-contrib.github.io/Cake.Recipe 2024 - Thu, 01 Aug 2024 20:27:29 GMT - Thu, 01 Aug 2024 20:27:29 GMT + Thu, 01 Aug 2024 20:38:25 GMT + Thu, 01 Aug 2024 20:38:25 GMT \ No newline at end of file