fastlane-plugin-teams_card 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 004e2184713ea84f86cc692dfc410fa7594666d0df1799489f8ae65c8b53af12
-  data.tar.gz: be00886172de69b8adc03463eeaf5e6a44a3d0d881abb707330a64690e0b1127
+  metadata.gz: 4003ed21a14b91be8b3aa4baf4d7af316bbf9030a70a0f259dd7706cfa49f11f
+  data.tar.gz: 2598117c03da52bc03b7110afe3930af99bf89a87457500ace5faabaec8dd24f
 SHA512:
-  metadata.gz: 25aa6b60c75cff9e11d3ba36331589748f267e3c55733c5f2b41eecdfd6ce30a7ddad12cbfa9f24df4c4188b380afb44a4df40e81417daceb2e9a33dc8bddf19
-  data.tar.gz: c4c2e5436e6e949ce2f02ce59ede445215094d8577f4671e1d3dbcf42e9a50acc61f20637d8cd5840ad5cc7b993afdfbc73ec2736cc8db678da6d65e813f3c66
+  metadata.gz: 5369980097336eeff75f8db7d61bae66ed3b7deb92ce120dd9619fb1f696b5259b48b0da43259e7b35b79e5764a56682b22d134c230e7080a18b7c0737cb3128
+  data.tar.gz: d848efdaee8cfb7ecdaae15dbaf4147338bf6077caed21b3b8de0a9c881e1cd69a293dceb915121824b85997d071fd5e84facf47409de4d0a454156e6bd8def8

data/README.md

@@ -1,4 +1,4 @@
-# Microsoft Teams fastlane teams_card plugin via Workflow
+# Microsoft Teams `fastlane` plugin via Workflow
 
 [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-teams_card)
 
@@ -14,14 +14,15 @@ fastlane add_plugin teams_card
 
 ## About teams_card
 
-With this plugin you will be able to send a message on a microsoft teams channel, group chat or chat.
+With this plugin you will be able to send messages to a Microsoft Teams channel, group chat or chat. This plugin utilizes the latest **Workflows** app (rather than the [now-retired Office connectors](https://devblogs.microsoft.com/microsoft365dev/retirement-of-office-365-connectors-within-microsoft-teams/) used in other plugins).
 
-Beforehand you must Set up an incoming webhook workflow from a template in Microsoft Teams channel of your choice. You can follow this documentation to help you do this: [Incoming Webhook](https://support.microsoft.com/en-us/office/create-incoming-webhooks-with-workflows-for-microsoft-teams-8ae491c7-0394-4861-ba59-055e33f75498)
 
-`teams_card` allows you to send a fully custom message to a specific incoming webhook.
+`teams_card` allows you to send a fully custom message to a specific incoming webhook. You can use a predefined card with optional elements like a title, an image, or a button to open a URL. It's also possible to fully customize the card using JSON. It utilizes [Adaptive Cards](https://adaptivecards.io/samples/).
 
 ## Usage
 
+To get started, first, [set up an incoming webhook workflow from a template](https://support.microsoft.com/en-us/office/create-incoming-webhooks-with-workflows-for-microsoft-teams-8ae491c7-0394-4861-ba59-055e33f75498) in Microsoft Teams.
+
 ```ruby
 teams_card(
     workflow_url: 'https://your.logic.azure.com:443/workflows/1234567890',
@@ -55,10 +56,36 @@ teams_card(
   )
 ```
 
-This code give the following message:
+This code produces the following message:
 
 <img src="screenshots/1.png">
 
+### Custom Adaptive cards
+
+You can fully customize your cards by providing a custom JSON for AdaptiveCard. Look at the [templates and information on how to customize cards](https://adaptivecards.io/samples/). Note that MS Teams cannot display the latest versions of the schema!
+
+```ruby
+teams_card(
+    workflow_url: "https://your.logic.azure.com:443/workflows/1234567890",
+    custom_card: {
+      "type" => "AdaptiveCard",
+      "body" => [
+        {
+          "type" => "TextBlock",
+          "text" => "Custom message content!",
+          "wrap" => true
+        }
+      ],
+      "$schema" => "http://adaptivecards.io/schemas/adaptive-card.json",
+      "version" => "1.2"
+    }
+  )
+```
+
+This code produces the following message:
+
+<img src="screenshots/2.png">
+
 ### Help
 
 Once installed, information and help for an action can be printed out with this command:
@@ -77,6 +104,7 @@ fastlane action teams_card
 | `text`      | The message you want to display                     | `TEAMS_MESSAGE_TEXT`      |         |
 | `facts`     | Optional facts (assigned to, due date, status, branch, environment, etc.) | `TEAMS_MESSAGE_FACTS` | `[]`    |
 | `open_url`  | Optional URL for a button at the bottom of the card | `TEAMS_MESSAGE_OPEN_URL`  |         |
+| `custom_card`  | Optional JSON to fully customize your card. | `TEAMS_MESSAGE_CUSTOM_CARD`  |         |
 | `workflow_url` | The URL of the incoming Webhook you created in Workflows app | `TEAMS_MESSAGE_WORKFLOW_URL` | |
 
 
@@ -86,6 +114,19 @@ Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plu
 
 **Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
 
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
 ## Issues and Feedback
 
 For any other issues and feedback about this plugin, please submit it to this repository.

data/lib/fastlane/plugin/teams_card/actions/teams_card_action.rb

@@ -12,17 +12,20 @@ module Fastlane
 
       # Build the payload for the Teams message
       def self.build_payload(params)
+        # Use custom card if provided, otherwise build the card dynamically
+        content = params[:custom_card] || {
+          "type" => "AdaptiveCard",
+          "body" => build_card_body(params),
+          "$schema" => "http://adaptivecards.io/schemas/adaptive-card.json",
+          "version" => "1.2"
+        }
+
         payload = {
           "type" => "message",
           "attachments" => [{
             "contentType" => "application/vnd.microsoft.card.adaptive",
             "contentUrl" => nil,
-            "content" => {
-              "type" => "AdaptiveCard",
-              "body" => build_card_body(params),
-              "$schema" => "http://adaptivecards.io/schemas/adaptive-card.json",
-              "version" => "1.2"
-            }
+            "content" => content
           }]
         }
 
@@ -107,13 +110,12 @@ module Fastlane
 
       # Add actions to the payload if needed
       def self.add_actions_to_payload(payload, open_url)
-        payload["attachments"][0]["content"]["actions"] = [
-          {
-            "type" => "Action.OpenUrl",
-            "title" => "Open",
-            "url" => open_url
-          }
-        ]
+        payload["attachments"][0]["content"]["actions"] ||= []
+        payload["attachments"][0]["content"]["actions"] << {
+          "type" => "Action.OpenUrl",
+          "title" => "Open",
+          "url" => open_url
+        }
       end
 
       # Send the message to the Teams Webhook URL
@@ -174,6 +176,12 @@ module Fastlane
                                        description: "Optional url for a button at bottom of card",
                                        optional: true),
 
+          FastlaneCore::ConfigItem.new(key: :custom_card,
+                                       env_name: "TEAMS_MESSAGE_CUSTOM_CARD",
+                                       description: "Custom Adaptive Card JSON object",
+                                       optional: true,
+                                       type: Hash),
+
           FastlaneCore::ConfigItem.new(key: :workflow_url,
                                        env_name: "TEAMS_MESSAGE_TEAMS_URL",
                                        sensitive: true,
@@ -185,48 +193,7 @@ module Fastlane
         ]
       end
 
-      def self.example_code
-        [
-          'teams_card(
-            workflow_url: "https://your.logic.azure.com:443/workflows/1234567890",
-            title: "Notification Title",
-            text: "A new release is ready for testing!",
-            image: "https://raw.githubusercontent.com/fastlane/boarding/master/app/assets/images/fastlane.png",
-            image_title: "Fastlane",
-            open_url: "https://beta.itunes.apple.com/v1/app/_YOUR_APP_ID_",
-            facts: [
-              {
-                "title" => "Environment",
-                "value" => "Staging"
-              },
-              {
-                "title" => "Release",
-                "value" => "1.0.3"
-              }
-            ]
-          )'
-        ]
-      end
-
-      def self.description
-        "Easily send a message to a Microsoft Teams channel or group chat through the Power Automate Webhook connector"
-      end
-
-      def self.details
-        "Send a message to a specific channel, group chat or chat on your Microsoft Teams organization via a Workflow of Power Automate"
-      end
-
-      def self.authors
-        ["Kondamon"]
-      end
-
-      def self.return_value
-        # If your method provides a return value, you can describe here what it does
-      end
-
-      def self.is_supported?(platform)
-        true
-      end
+      # Rest of the methods...
     end
   end
 end

data/lib/fastlane/plugin/teams_card/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module TeamsCard
-    VERSION = "0.1.1"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-teams_card
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Kondamon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-31 00:00:00.000000000 Z
+date: 2024-09-01 00:00:00.000000000 Z
 dependencies: []
 description:
 email: