cake-contrib / cake.slack Goto Github PK

View Code? Open in Web Editor NEW

19.0 8.0 15.0 668 KB

Cake AddIn that extends Cake with Slack messaging features

Home Page: https://cakebuild.net/extensions/cake-slack

License: MIT License

PowerShell 0.37% C# 99.26% Shell 0.37%

cake-build cake-addin

cake.slack's Introduction

Cake.Slack

Cake AddIn that extends Cake with Slack messaging features

Usage

Post message

Using token

#addin "Cake.Slack"
var slackToken = EnvironmentVariable("SLACK_TOKEN");
var slackChannel = "#cake";
var postMessageResult = Slack.Chat.PostMessage(
            token:slackToken,
            channel:slackChannel,
            text:"This _is_ a `message` from *CakeBuild* :thumbsup:\r\n```Here is some code```"
    );

if (postMessageResult.Ok)
{
    Information("Message {0} successfully sent", postMessageResult.TimeStamp);
}
else
{
    Error("Failed to send message: {0}", postMessageResult.Error);
}

Cake output will be similar to below:

Message 1420896696.000057 successfully sent

This will result in an message in your Slack channel similar to below:

Using incoming web hook url

#addin "Cake.Slack"
var slackhookuri = EnvironmentVariable("slackhookuri");
var slackChannel = "#cake";
var postMessageResult = Slack.Chat.PostMessage(
            channel:slackChannel,
            text:"This _is_ a `message` from *CakeBuild* :thumbsup:\r\n```Here is some code```",
            messageSettings:new SlackChatMessageSettings { IncomingWebHookUrl = slackhookuri }
    );

if (postMessageResult.Ok)
{
    Information("Message successfully sent");
}
else
{
    Error("Failed to send message: {0}", postMessageResult.Error);
}

Cake output will be similar to below:

Message successfully sent

This will result in an message in your Slack channel similar to below:

Using message attachments

#addin "Cake.Slack"
var slackWebHookUrl = EnvironmentVariable("slackWebHookUrl");
var slackChannel = "#cake";
var slackAssemblyFieldAttachment = new SlackChatMessageAttachmentField[]
{
            new SlackChatMessageAttachmentField
            {
                Title =  "Message Attachment Title",
            	Value =  "Message Attachment Value"
            }
};
var postMessageResult = Slack.Chat.PostMessage(
	channel:slackChannel,
	text:"Starting Cake Build...",
	messageAttachments:new SlackChatMessageAttachment[]
	{
	            new SlackChatMessageAttachment
	            {
	                        Text = "Cake Text",
	                        Pretext = "Cake Pretext",
	                        Color = "#67A0E1",
	                        Fields = slackAssemblyFieldAttachment
	            }
     },
	messageSettings:new SlackChatMessageSettings { IncomingWebHookUrl = slackWebHookUrl });

if (postMessageResult.Ok)
{
    Information("Message successfully sent");
}
else
{
    Error("Failed to send message: {0}", postMessageResult.Error);
}

This will result in a message in your Slack channel similar to below:

Discussion

For questions and to discuss ideas & feature requests, use the GitHub discussions on the Cake GitHub repository, under the Extension Q&A category.

cake.slack's People

Stargazers

Watchers

Forkers

marcosnz devlead dbertram pascalberger ssasoglu gep13 wcomab mabreuortega kolesnick nmbro yuft augustoproiete-forks narcopanda nils-a

cake.slack's Issues

Update DPI to 2021.12.8.49

Add possibility to send files in channel

Please add possibility to send files (.txt, .zip and etc) into slack channel. For now managed to do this only using http client.

LitJSON serialize properties .ToLower()

Can the LitJSON serialize C# properties ToLower() ? I have a feature I'd like to submit, but can't get LitJSON to convert my C# object to the JSON array without making all my C# properties lower case.

If not are you okay with the potential switch to Newtonsoft? I have proved that I can get it working with that library.

Thanks!
--Rodney

Not working with "Cake.Core" Version="3.1.0"

Hi Team,

I am receiving the below error when I upgraded to "Cake.Core" Version="3.1.0". How to fix this issue?

Error: System.NullReferenceException: Object reference not set to an instance of an object.
at Submission#0.Build.<>c.<.cctor>b__108_0(GitVersion version)
at Submission#0.Build.get_Version()
at Submission#0.SlackReport.Send(ICakeContext context)
at Submission#0.<>c.<>b__0_0(ITeardownContext context)
at Cake.Core.DefaultExecutionStrategy.PerformTeardown(Action1 action, ITeardownContext teardownContext) in C:\projects\cake\src\Cake.Core\DefaultExecutionStrategy.cs:line 56 at Cake.Core.CakeEngine.PerformTeardown(IExecutionStrategy strategy, ICakeContext context, Stopwatch stopWatch, CakeReport report, Boolean exceptionWasThrown, Exception thrownException) in C:\projects\cake\src\Cake.Core\CakeEngine.cs:line 510 at Cake.Core.CakeEngine.RunTargetAsync(ICakeContext context, IExecutionStrategy strategy, ExecutionSettings settings) in C:\projects\cake\src\Cake.Core\CakeEngine.cs:line 212 at Cake.Cli.BuildScriptHost1.internalRunTargetAsync() in C:\projects\cake\src\Cake.Cli\Hosts\BuildScriptHost.cs:line 87
at Cake.Cli.BuildScriptHost1.RunTargetAsync(String target) in C:\projects\cake\src\Cake.Cli\Hosts\BuildScriptHost.cs:line 74 1241&logView=flowAware&linesState=1241) at Cake.Core.Scripting.ScriptHost.RunTarget(String target) in C:\projects\cake\src\Cake.Core\Scripting\ScriptHost.cs:line 110 at Submission#0.<<Initialize>>d__0.MoveNext() --- End of stack trace from previous location --- at Microsoft.CodeAnalysis.Scripting.ScriptExecutionState.RunSubmissionsAsync[TResult](ImmutableArray1 precedingExecutors, Func2 currentExecutor, StrongBox1 exceptionHolderOpt, Func2 catchExceptionOpt, CancellationToken cancellationToken) at Microsoft.CodeAnalysis.Scripting.Script1.RunSubmissionsAsync(ScriptExecutionState executionState, ImmutableArray1 precedingExecutors, Func2 currentExecutor, Func`2 catchExceptionOpt, CancellationToken cancellationToken)
at Cake.Infrastructure.Scripting.RoslynScriptSession.Execute(Script script) in C:\projects\cake\src\Cake\Infrastructure\Scripting\RoslynScriptSession.cs:line 206
at Cake.Core.Scripting.ScriptRunner.Run(IScriptHost host, FilePath scriptPath) in C:\projects\cake\src\Cake.Core\Scripting\ScriptRunner.cs:line 172
at Cake.Features.Building.BuildFeature.RunCore(IRemainingArguments arguments, BuildFeatureSettings settings) in C:\projects\cake\src\Cake\Features\Building\BuildFeature.cs:line 99
at Cake.Features.Building.BuildFeature.Run(IRemainingArguments arguments, BuildFeatureSettings settings) in C:\projects\cake\src\Cake\Features\Building\BuildFeature.cs:line 49
at Cake.Commands.DefaultCommand.Execute(CommandContext context, DefaultCommandSettings settings) in C:\projects\cake\src\Cake\Commands\DefaultCommand.cs:line 73

Regards,
Sanjay

General code improvements

Since I've spent some time debuggin the #25 I've seen some repeated code and some stuff that could be cleaner and more compact.

Can I help with that? @gep13 @devlead.

Failed to send message: not_authed

Hi!
I use Cake.Slack. I am following the example with github, but I get the error message "Failed to send message: not_another".
What could this be related to? Thanks!

Add attachment sample code to README.md

Update Cake.Slack NuGet package icon to the new Cake-Contrib logo for Cake addins

We've recently released new icons for Cake extensions, to help more easily differentiate Cake Addins, Modules, Recipes, etc.

More information: https://github.com/cake-contrib/graphics

Bump to Cake 0.33.0 to reduce warnings

Upgrade to VS2017 and add .NET Core target

So addin can be loaded from Cake CoreCLR runner

Update to latest Cake

With the upcoming release of 0.18.0, there is a requirement that all addin's have a minimum version of Cake, i.e. 0.16.2 and above.

@devlead would you be in a position to update this addin to the latest Cake version, so that it will be supported OOTB?

Thanks!

Unable to post via chat API

Trying to use this code:

var slackToken         = "blah";
var slackChannel        = "blah";

try
    {
        Information("Sending message to Slack...");

        var postMessageResult = Slack.Chat.PostMessage(
                    token: slackToken,
                    channel: slackChannel,
                    text: "this is a test"
            );

        if (postMessageResult.Ok)
        {
            Information("Message {0} successfully sent", postMessageResult.TimeStamp);
        }
        else
        {
            Error("Failed to send message: {0}", postMessageResult.Error);
        }
    }
    catch(Exception ex)
    {
        Error("{0}", ex);
    }
});

results in:

Failed to send message: not_authed

Seems like there was a breaking change in Slack API, as the token is no longer passed in JSON payload, but rather as part of the URL.

Update to Cake 1.3.0

Add netcoreapp3.1, net5.0 and net6.0 target framework

Update Cake.Slack to target Cake v1.0.0

https://cakebuild.net/blog/2021/02/cake-v1.0.0-released

Update Cake.Slack add-in to target Cake v2.0.0

Cake 2.0.0 has been released 🎉

Add cake-addin tag to Cake.Slack NuGet package

The NuGet Gallery will soon include a "Cake" tab with instructions on how to use NuGet packages in Cake build scripts. I'd like to suggest that you include the tag cake-addin in the NuGet package of this addin, so that the NuGet Gallery can display the correct instructions to install this addin.

The UI will look similar to this:

Documentation on best practices on tags for Cake addins: https://cakebuild.net/docs/extending/addins/best-practices#tags

Remove netstandard2.0 and net461 target frameworks

Would it be possible to use the Cake Contrib Icon for your NuGet Package?

Thanks again for creating this Cake Addin, we really appreciate the effort that you have put in to creating it.

We, the Cake Team, recently announced a new Cake Contrib Icon, details of which can be found here:

http://cakebuild.net/blog/2017/06/new-cake-contrib-icon

Would you consider changing the nuspec file for your NuGet Package to use this new Cake Contrib Icon? If so, the recommended URL to use is:

https://cdn.rawgit.com/cake-contrib/graphics/a5cf0f881c390650144b2243ae551d5b9f836196/png/cake-contrib-medium.png

Details of the above URL can be found in the repository here:

https://github.com/cake-contrib/graphics

Please let me know if you have any questions.

Upgrading to .NET Framework 4.6.1

Is upgrading .NET Framework 4.6.1 in your roadmap? If yes, may i get the expected date?

Update Cake.Slack README: Add link to GitHub Discussions

We've started using GitHub Discussions as the preferred communication channel moving forward (instead of Gitter) because it makes it easier to keep track of discussions in a structured way, especially if multiple discussions are happening at the same time. It also allows to search for previous questions/answers, which can be a helpful resource.

As such, we're recommending addin maintainers to update any links to Gitter to point to the GH discussions.

Template:

## Discussion

For questions and to discuss ideas & feature requests, use the [GitHub discussions on the Cake GitHub repository](https://github.com/cake-build/cake/discussions), under the [Extension Q&A](https://github.com/cake-build/cake/discussions/categories/extension-q-a) category.

[![Join in the discussion on the Cake repository](https://img.shields.io/badge/GitHub-Discussions-green?logo=github)](https://github.com/cake-build/cake/discussions)

Question: How to setup Slack for this to work?

Hi there,
I'm having trouble finding out how to setup my slack workspace for this to work.

Any hints?

Add XML sample code to SlackChatProvider

Add XML doc example code to SlackChatProvider methods.

Example of xml doc example code syntax here

Update Cake.Recipe to 2.2.1

Recommended changes resulting from automated audit

We performed an automated audit of your Cake addin and found that it does not follow all the best practices.

We encourage you to make the following modifications:

You are currently referencing Cake.Core 0.26.0. Please upgrade to 0.28.0
You are currently referencing Cake.Common 0.26.0. Please upgrade to 0.28.0
The Cake.Core reference should be private. Specifically, your addin's .csproj should have a line similar to this: <PackageReference Include="Cake.Core" Version="0.28.0" PrivateAssets="All" />
The Cake.Common reference should be private. Specifically, your addin's .csproj should have a line similar to this: <PackageReference Include="Cake.Common" Version="0.28.0" PrivateAssets="All" />
Your addin should target netstandard2.0. Please note that there is no need to multi-target, netstandard2.0 is sufficient.

Apologies if this is already being worked on, or if there are existing open issues, this issue was created based on what is currently published for this package on NuGet.org and in the project on github.