Slack Git



Our Slack admin was able to solve this, posting the solution here in case anyone else runs across it: We have 6 workspaces that had the github app (legacy) installed and I had to do the upgrade on all of them. Download Git 2.14.2. Cool Software for Companies.

  1. Slack Git Integration
  2. Slack Gitlab
  3. Slack Github
  4. Slack Git Integration
  5. Slack Github Enterprise
  6. Slack Github App

시간을 절약하고 인적 오류를 줄이는 데 도움이됩니다.그러나 자동화는 어려울 수 있으며 때로는 비용이 많이들 수 있습니다. Github Actions는 어떻게 코드를 강화하고 버그 대신 기능 작업에 더 많은 시간을 할애 할 수 있습니까?Github 작업이란 무엇입니까?CI / CD 란 무엇입니까?무엇을 만들까요?파트 0. This is personal webpage and everything written here is my personal opinion, that doesn’t represent official position of any company/entity that I’m working for or might be associated with. Source: This guide describes how to integrate your Zabbix 4.4 installation with Slack using the Zabbix webhook.

Connect systems with Reshuffle.

The Github integration for Slack is great for team productivity. Having the ability to give Slack channels full visibility into Github projects, for real-time notifications, is an amazing way to keep the development team on the same page. However, this can become a double-edged sword. Developers may decide to ignore these messages being sent because it may be information overload.

I’ve been in a similar situation where pull requests needed approval from reviewers but they wouldn’t check the channels or their emails. The only thing that got their attention were direct messages. This hindered delivery and having to ping the reviewer myself was becoming a pain.

As great as the Github app for Slack is, I wanted something more custom that would suit my needs. For example, whenever a pull request is made with reviewers, only send direct messages to those who have been requested.

In this article, we will use Github, Slack, and Reshuffle to create the workflow to directly message the reviewers on a pull request.

How to Build It

Before getting started with the code, we’ll need to get credentials set up with Github and Slack.

Github

  • Log in and generate a token here
  • Save the token somewhere, as you'll need it soon

Slack

  • Create a new Slack App here
  • Enter the App name and select the workspace
  • Click on Create App
  • Click on your new App
  • The signing secret is under Basic Information > App Credentials
  • The token is under Settings > Install App > OAuth Access Token
  • Save the token and signing secret somewhere, as you'll need it soon

See links for full documentation:

With the credentials saved somewhere safe, we can begin by instantiating a Reshuffle app and configuring the connectors.

Note: The Github Connector requires a runTimeBaseUrl. A tool like ngrok can be used to generate a url that exposes your localhost over SSL.

Reshuffle Connectors provide events and actions that allow developers to easily build custom workflows and integrations. We’re now able to take advantage of what they can do.

We’ll continue by getting a list of the user’s Github handles and their Slack IDs. In order to get this data, we use a method on Slack Connector that exposes Slack's web client actions.

Note: In this example, display_name is being assumed to be the same as the Github handle. You can definitely add your own profile fields that suit your team.

Next, we’ll write a helper function to handle the event when a pull request is created, this will take in a list of reviewers from Github, the user list from Slack, and the link url to the pull request. If there are no reviewers, we’ll simply post to the general channel, otherwise, we match the reviewers to the slack members list and send them a direct message.

To tie everything together, we configure the Github Connector to trigger an event anytime a pull request is created.

Note: See the full list of available events here

We can get the list of requested reviewers from the event object, passing onto our helper, which is only called if the event action matches “opened” or “reopened”.

Note: For more information on the parameters of postMessage check the docs.

With that, we’re finished, any time a pull requests is created with reviewers, they are directly messaged.

As a bonus, if the reviewers forget about the pull request, we can use the Cron Connector as a scheduler to check for any open PRs on the repository and message the reviewers.

This example provides a good starting point to how you can easily create a custom workflow for your team's needs using Reshuffle.

Now, Make it Happen

As your developers and project management teams experience the ease of working with integrated applications, we encourage you to consider where else integrating workflows would benefit your teams. With so many different tools, the more you can consolidate them into one common interface, the easier people can get work done.

Reshuffle is continually listening to what our customers need and desire. Don't see a Connector to a service you'd like to integrate? Send a tweet to @ReshuffleHQ to let us know which Connector you'd like us to develop next.

自動化は強力なツールです。それは私たちの時間を節約し、人的エラーを減らすのに役立ちます。

ただし、自動化は困難な場合があり、コストがかかる場合があります。Githubアクションは、コードを強化し、バグではなく機能に取り組む時間を増やすのにどのように役立ちますか？

  • Githubアクションとは何ですか？
  • CI / CDとは何ですか？
  • 何を構築しますか？
  • パート0：プロジェクトの設定
  • パート1：テストの自動化
  • パート2：新しいプルリクエストをSlackに投稿する

Githubアクションとは何ですか？

アクションはGithubの比較的新しい機能であり、Githubリポジトリ内の構成ファイルを使用してCI / CDワークフローを設定できます。

以前は、テスト、ビルド、またはデプロイメントを使用してあらゆる種類の自動化をセットアップする場合は、Circle CIやTravisなどのサービスを探すか、独自のスクリプトを作成する必要がありました。しかし、アクションを使用すると、ワークフローを自動化するための強力なツールに対するファーストクラスのサポートが得られます。

CI / CDとは何ですか？

CD / CDは、継続的インテグレーションと継続的デプロイメントの略です（または継続的デリバリーの場合もあります）。これらは両方ともソフトウェア開発の実践であり、チームがプロジェクトを迅速、効率的、理想的にはエラーを減らして一緒に構築できるようにします。

継続的インテグレーションとは、チームのさまざまなメンバーがさまざまなgitブランチでコードを処理するときに、コードが1つの作業ブランチにマージされ、自動化されたワークフローで構築およびテストされるという考え方です。これは、全員のコードが適切に連携し、十分にテストされていることを常に確認するのに役立ちます。

継続的デプロイはこれをさらに一歩進め、この自動化をデプロイメントレベルに引き上げます。CIプロセスでは、テストとビルドを自動化しますが、継続的デプロイはプロジェクトの環境へのデプロイを自動化します。

アイデアは、コードがビルドおよびテストプロセスを通過すると、デプロイ可能な状態になるため、デプロイできるはずであるということです。

何を構築しますか？

2つの異なるワークフローに取り組みます。

1つ目は、プルリクエストが失敗した場合にマージされないようにする、いくつかの自動テストを実行することです。テストの構築については説明しませんが、既存のテストの実行については説明します。

第2部では、新しいメッセージが作成されるたびにプルリクエストへのリンクを含むメッセージをSlackに送信するワークフローを設定します。これは、チームでオープンソースプロジェクトに取り組むときに非常に役立ち、リクエストを追跡する方法が必要です。

パート0：プロジェクトの設定

このガイドでは、パート1で実行できるテストがあれば、ノードベースのプロジェクトを実際に実行できます。

私が使用するより簡単な例に沿って進みたい場合は、実行して合格できる2つのテストを持つ単一の関数で複製できる新しいプロジェクトを設定しました。

Slack git integration

開始するためにこのコードをチェックアウトしたい場合は、以下を実行できます。

ローカルでクローンを作成し、依存関係をインストールすると、テストを実行して合格することができるはずです。

また、フォローするには、このプロジェクトをGithubの新しいリポジトリとして追加する必要があることにも注意してください。

コミットに従ってください！

パート1：テストの自動化

テストは、作業中に既存のコードを壊していないことを確認できるプロジェクトの重要な部分です。それらは重要ですが、忘れがちです。

方程式から人間性を取り除き、テストの実行を自動化して、壊れたものを修正せずに続行できないことを確認できます。

ステップ1：新しいアクションを作成する

良いニュースは、Githubが実際にこのワークフローを開始するのを本当に簡単にしていることです。

まず、リポジトリページの[アクション]タブに移動します。

そこに着くと、Githubが提供するいくつかのスターターワークフローがすぐにわかります。ノードプロジェクトを使用しているので、先に進んで、Node.jsワークフローの下にある[このワークフローのセットアップ]をクリックします。

ページが読み込まれると、Githubは、すでに多数の構成オプションが追加されている新しいファイルエディターを表示します。

実際には、最初のステップとしてこれを「そのまま」にしておきます。オプションで、ファイルの名前をtests.yml覚えやすい名前に変更できます。

先に進んで[コミットの開始]をクリックし、ディレクトリをmasterブランチにコミットするか、変更を新しいブランチに追加します。このウォークスルーでは、に直接コミットしmasterます。

To see our new action run, we can again click on the Actions tab which will navigate us back to our new Actions dashboard.

From there, you can click on Node.js CI and select the commit that you just made above and you'll land on our new action dashboard. You can then click one of the node versions in the sidebar via build (#.x), click the Run npm test dropdown, and we'll be able to see the output of our tests being run (which if you're following along with me, should pass!).

Follow along with the commit!

Step 2: Configuring our new action

So what did we just do above? We'll walk through the configuration file and what we can customize.

Starting from the top, we specify our name:

This can really be whatever you want. Whatever you pick should help you remember what it is. I'm going to customize this to 'Tests' so I know exactly what's going on.

The on key is how we specify what events trigger our action. This can be a variety of things like based on time with cron. But here, we're saying that we want this action to run any time someone pushes commits to master or someone creates a pull request targeting the master branch. We're not going to make a change here.

This next bit creates a new job called build. Here we're saying that we want to use the latest version of Ubuntu to run our tests on. Ubuntu is common, so you'll only want to customize this if you want to run it on a specific environment.

Inside of our job we specify a strategy matrix. This allows us to run the same tests on a few different variations.

In this instance, we're running the tests on 3 different versions of node to make sure it works on all of them. This is definitely helpful to make sure your code is flexible and future proof, but if you're building and running your code on a specific node version, you're safe to change this to only that version.

Finally, we specify the steps we want our job to run. Breaking this down:

  • uses: actions/[email protected]: In order for us to run our code, we need to have it available. This checks out our code on our job environment so we can use it to run tests.
  • uses: actions/[email protected]: Since we're using node with our project, we'll need it set up on our environment. We're using this action to do that setup for us for each version we've specified in the matrix we configured above.
  • run: npm ci: If you're not familiar with npm ci, it's similar to running npm install but uses the package-lock.json file without performing any patch upgrades. So essentially, this installs our dependencies.
  • run: npm run build --if-present: npm run build runs the build script in our project. The --if-present flag performs what it sounds like and only runs this command if the build script is present. It doesn't hurt anything to leave this in as it won't run without the script, but feel free to remove this as we're not building the project here.
  • run: npm test: Finally, we run npm test to run our tests. This uses the test npm script set up in our package.json file.

And with that, we've made a few tweaks, but our tests should run after we've committed those changes and pass like before!

Follow along with the commit!

Step 3: Testing that our tests fail and prevent merges

Now that our tests are set up to automatically run, let's try to break it to see it work.

At this point, you can really do whatever you want to intentionally break the tests, but here's what I did:

I'm intentionally returning different expected output so that my tests will fail. And they do!

In my new pull request, my new branch breaks the tests, so it tells me my checks have failed. If you noticed though, it's still green to merge, so how can we prevent merges?

We can prevent pull requests from being merged by setting up a Protected Branch in our project settings.

First, navigate to Settings, then Branches, and click Add rule.

We'll then want to set the branch name pattern to *, which means all branches, check the Require status checks to pass before merging option, then select all of our different status checks that we'd like to require to pass before merging.

Finally, hit Create at the bottom of the page.

And once you navigate back to the pull request, you'll notice that the messaging is a bit different and states that we need our statuses to pass before we can merge.

Note: as an administrator of a repository, you'll still be able to merge, so this technically only prevents non-administrators from merging. But will give you increased messaging if the tests fail.

And with that, we have a new Github Action that runs our tests and prevents pull requests from merging if they fail.

Follow along with the pull request!

Note: we won't be merging that pull request before continuing to Part 2.

Part 2: Post new pull requests to Slack

Now that we're preventing merge requests if they're failing, we want to post a message to our Slack workspace whenever a new pull request is opened up. This will help us keep tabs on our repos right in Slack.

For this part of the guide, you'll need a Slack workspace that you have permissions to create a new developer app with and the ability to create a new channel for the bot user that will be associated with that app.

Step 1: Setting up Slack

There are a few things we're going to walk through as we set up Slack for our workflow:

  • Create a new app for our workspace
  • Assign our bot permissions
  • Install our bot to our workspace
  • Invite our new bot to our channel

To get started, we'll create a new app. Head over to the Slack API Apps dashboard. If you already haven't, log in to your Slack account with the Workspace you'd like to set this up with.

Now, click Create New App where you'll be prompted to put in a name and select a workspace you want this app to be created for. I'm going to call my app 'Gitbot' as the name, but you can choose whatever makes sense for you. Then click Create App.

Once created, navigate to the App Home link in the left sidebar. In order to use our bot, we need to assign it OAuth scopes so it has permissions to work in our channel, so select Review Scopes to Add on that page.

Scroll own and you'll see a Scopes section and under that a Bot Token section. Here, click Add an OAuth Scope. For our bot, we don't need a ton of permissions, so add the channels:join and chat:write scopes and we should be good to go.

Now that we have our scopes, let's add our bot to our workspace. Scroll up on that same page to the top and you'll see a button that says Install App to Workspace.

Once you click this, you'll be redirected to an authorization page. Here, you can see the scopes we selected for our bot. Next, click Allow.

At this point, our Slack bot is ready to go. At the top of the OAuth & Permissions page, you'll see a Bot User OAuth Access Token. This is what we'll use when setting up our workflow, so either copy and save this token or remember this location so you know how to find it later.

Note: this token is private - don't give this out, show it in a screencast, or let anyone see it!

Finally, we need to invite our Slack bot to our channel. If you open up your workspace, you can either use an existing channel or create a new channel for these notifications, but you'll want to enter the command /invite @[botname] which will invite our bot to our channel.

And once added, we're done with setting up Slack!

Create a Github Action to notify Slack

Our next step will be somewhat similar to when we created our first Github Action. We'll create a workflow file which we'll configure to send our notifications.

While we can use our code editors to do this by creating a file in the .github directory, I'm going to use the Github UI.

First, let's navigate back to our Actions tab in our repository. Once there, select New workflow.

This time, we're going to start the workflow manually instead of using a pre-made Action. Select set up a workflow yourself at the top.

Once the new page loads, you'll be dropped in to a new template where we can start working. Here's what our new workflow will look like:

So what's happening in the above?

  • name: we're setting a friendly name for our workflow
  • on: we want our workflow to trigger when there's a pull request is created that targets our master branch
  • jobs: we're creating a new job called notifySlack
  • jobs.notifySlack.runs-on: we want our job to run on a basic setup of the latest Unbuntu
  • jobs.notifySlack.steps: we really only have one step here - we're using a pre-existing Github Action called Slack Action and we're configuring it to publish a notification to our Slack

There are two points here we'll need to pay attention to, the env.SLACK_BOT_TOKEN and the with.args.

In order for Github to communicate with Slack, we'll need a token. This is what we're setting in env.SLACK_BOT_TOKEN. We generated this token in the first step. Now that we'll be using this in our workflow configuration, we'll need to add it as a Git Secret in our project.

Slack Git Integration

The with.args property is what we use to configure the payload to the Slack API that includes the channel ID (channel) and our actual message (blocks).

The payload in the arguments is stringified and escaped. For example, when expanded it looks like this:

Note: this is just to show what the content looks like, we need to use the original file with the stringified and escaped argument.

Back to our configuration file, the first thing we set is our channel ID. To find our channel ID, you'll need to use the Slack web interface. Once you open Slack in your browser, you want to find your channel ID in the URL:

With that channel ID, you can modify our workflow configuration and replace [Channel ID] with that ID:

The rest of the arguments property is how we set up our message. It includes variables from the Github event that we use to customize our message.

We won't go into tweaking that here, as what we already have will send a basic pull request message, but you can test out and build your own payload with Slack's Block Kit Builder.

Follow along with the commit!

Slack Gitlab

Test out our Slack workflow

So now we have our workflow configured with our Slack app, finally we're ready to use our bot!

For this part, all we need to do is create a new pull request with any change we want. To test this out, I simply created a new branch where I added a sentence to the README.md file.

Once you create that pull request, similar to our tests workflow, Github will run our Slack workflow! You can see this running in the Actions tab just like before.

As long as you set everything up correctly, once the workflow runs, you should now have a new message in Slack from your new bot.

Note: we won't be merging that pull request in.

What else can we do?

Customize your Slack notifications

The message I put together is simple. It tells us who created the pull request and gives us a link to it.

To customize the formatting and messaging, you can use the Github Block Kit Builder to create your own.

If you'd like to include additional details like the variables I used for the pull request, you can make use of Github's available contexts. This lets you pull information about the environment and the job to customize your message.

I couldn't seem to find any sample payloads, so here's an example of a sample github context payload you would expect in the event.

Slack Github

Sample github context

その他のGithubアクション

新しいカスタムワークフローを作成する機能があるため、自動化できないことはそれほど多くありません。Githubには、1つを閲覧できるマーケットプレイスもあります。

さらに一歩進めたい場合は、独自に作成することもできます。これにより、スクリプトを設定して、プロジェクトに必要なタスクを実行するワークフローを構成できます。

会話に参加してください！

。@ githubアクションは、開発ワークフローを自動化するための素晴らしい方法ですか？

テストの実行の自動化や@slackへの通知の送信などを行うことができます。？

ここでは、アクションとは何か、およびアクションをプロジェクトでどのように使用できるかについて説明します。

？// t.co / CNDIsNXbhm

Slack Git Integration

—コルビー・ファイオック（@colbyfayock）2020年6月3日

Slack Github Enterprise

Githubアクションを何に使用しますか？

Twitterで私と共有してください！

Slack Github App

  • ？Twitterでフォローミー
  • ？️私のYoutubeを購読する
  • ✉️私のニュースレターにサインアップ