allure-report-publisher 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d33ea0e4d124c07ae275376e075ab14d3bcfedc7b5d71fdd23b78882e436c09
-  data.tar.gz: 94d3d70c631aeb9b79aa71fbd18cc920f95cfbe29320c12166d81d1de913cc7a
+  metadata.gz: 9231271e7296dcc0921871769aff6442e2a6eb1bb919574b72cb8753be897b4c
+  data.tar.gz: ebf30bece57cd457150bc9002b731fce743914f5ab9a11c6457d8e50151b1d2b
 SHA512:
-  metadata.gz: e4ba711128088e03fdf2a0f77e9890d33b6eee5e5e1671b613203e2700fdbd715e690ddf4964bcc82762f144560e83333af7e46f22d82c6c96b408f931a33830
-  data.tar.gz: 2b263c7e7e48d244f30df4efec6358599f31f79f832888a6083b7d3c2dbdaa40458f0216e13142ac9004f20be3efc58c9d2b9f87f57a500da662791ef68151a9
+  metadata.gz: 1cd52b5982eb6a5023b7a000a426fefc207aaf9934c84c1364dc51f3f6079058381fd55672c98cc150622702f83300da25c7a369410488cc2b809a1938778d8d
+  data.tar.gz: d924adb83f5739a791b16d66bdbe580bb0c6712d7d502f14e115a55ebac621884e14a1a97ac46369be4c1de1eabaecc64288e5d0256bc735cef4594b7e41f35c

data/README.md

@@ -47,7 +47,7 @@ Options:
   --results-glob=VALUE              # Allure results files glob. Required: true
   --bucket=VALUE                    # Bucket name. Required: true
   --prefix=VALUE                    # Optional prefix for report path. Required: false
-  --update-pr=VALUE                 # Add report url to PR via comment or description update. Required: false: (comment/description)
+  --update-pr=VALUE                 # Add report url to PR via comment or description update. Required: false: (comment/description/actions)
   --summary=VALUE                   # Additionally add summary table to PR comment or description. Required: false: (behaviors/suites/packages/total)
   --summary-table-type=VALUE        # Summary table type. Required: false: (ascii/markdown), default: :ascii
   --[no-]collapse-summary           # Create summary as a collapsable section, default: false
@@ -109,7 +109,7 @@ Following CI providers are supported:
 
 It is possible to update pull requests with urls to published reports and execution summary.
 
-- `--update-pr=(comment|description)`: post report urls in pr description or as a comment
+- `--update-pr=(comment|description|actions)`: post report urls in pr description, as a comment or step summary for github actions
 - `--summary=(behaviors|suites|packages|total)`: add execution summary table
 - `--summary-table-type=(ascii|markdown)`: use markdown or ascii table formatting
 - `--[no-]collapse-summary`: add summary in collapsable section

data/lib/allure_report_publisher/commands/upload.rb

@@ -22,7 +22,7 @@ module Publisher
       option :update_pr,
              type: :string,
              desc: "Add report url to PR via comment or description update. Required: false",
-             values: %w[comment description]
+             values: %w[comment description actions]
       option :summary,
              type: :string,
              desc: "Additionally add summary table to PR comment or description. Required: false",
@@ -77,7 +77,7 @@ module Publisher
         return unless args[:update_pr] && uploader.pr?
 
         log("Adding reports urls")
-        Spinner.spin("updating", exit_on_error: false) { uploader.add_url_to_pr }
+        Spinner.spin("updating", exit_on_error: false) { uploader.add_result_summary }
       end
 
       private

data/lib/allure_report_publisher/lib/providers/_provider.rb

@@ -53,7 +53,7 @@ module Publisher
       # Add report url to pull request description
       #
       # @return [void]
-      def add_report_url
+      def add_result_summary
         raise("Not a pull request, skipped!") unless pr?
         return add_comment if comment?
 

data/lib/allure_report_publisher/lib/providers/github.rb

@@ -58,6 +58,8 @@ module Publisher
       #
       # @return [void]
       def update_pr_description
+        return File.write(step_summary_file, url_section_builder.comment_body) if actions?
+
         client.update_pull_request(repository, pr_id, body: url_section_builder.updated_pr_description(pr_description))
       end
 
@@ -137,6 +139,26 @@ module Publisher
 
         "[#{short_sha}](#{server_url}/#{repository}/pull/#{pr_id}/commits/#{sha})"
       end
+
+      # Use actions summary for results
+      #
+      # @return [Boolean]
+      def actions?
+        update_pr == "actions"
+      end
+
+      # Github actions summary file
+      #
+      # @return [String]
+      def step_summary_file
+        @step_summary_file ||= begin
+          summary_file = ENV["GITHUB_STEP_SUMMARY"]
+          raise("Environment variable GITHUB_STEP_SUMMARY is empty!") unless summary_file
+          raise("Step summary file '#{summary_file}' does not exist!") unless File.exist?(summary_file)
+
+          summary_file
+        end
+      end
     end
   end
 end

data/lib/allure_report_publisher/lib/uploaders/_uploader.rb

@@ -47,7 +47,7 @@ module Publisher
       def execute
         generate_report
         upload
-        add_url_to_pr
+        add_result_summary
       end
 
       # Generate allure report
@@ -70,10 +70,10 @@ module Publisher
       # Add allure report url to pull request description
       #
       # @return [void]
-      def add_url_to_pr
+      def add_result_summary
         return unless update_pr && ci_provider
 
-        ci_provider.add_report_url
+        ci_provider.add_result_summary
       end
 
       # Uploaded report urls

data/lib/allure_report_publisher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Publisher
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-04 00:00:00.000000000 Z
+date: 2022-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -19,7 +19,7 @@ dependencies:
         version: 1.93.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.114.0
+        version: 1.115.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 1.93.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.114.0
+        version: 1.115.0
 - !ruby/object:Gem::Dependency
   name: dry-cli
   requirement: !ruby/object:Gem::Requirement
@@ -50,6 +50,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: gitlab
   requirement: !ruby/object:Gem::Requirement
@@ -182,28 +196,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.17.0
+        version: 2.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.17.0
+        version: 2.18.0
 - !ruby/object:Gem::Dependency
   name: climate_control
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -336,14 +350,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.44.3
+        version: 0.45.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.44.3
+        version: 0.45.0
 description: Upload allure reports to different file storage providers
 email:
 - andrejs.cunskis@gmail.com