duel 0.1.1 → 0.1.2

data/sig/duel/config.rbs

@@ -13,6 +13,12 @@ module Duel
     # When the workflow comments on a pull request (see #comment).
     type comment = :always | :results | :failures | :never
 
+    # Which runs a regression fails (see #fail_on).
+    type fail_on = :every_run | :pull_requests
+
+    # What a push is compared with (see #push_base).
+    type push_base = :before | :last_passed
+
     @root: String
     @benchmarks: String
     @watch: Array[String]
@@ -23,6 +29,9 @@ module Duel
     @prepares: Hash[Symbol, Array[prepare]]
     @ruby: ruby
     @comment: comment
+    @fail_on: fail_on
+    @push_base: push_base
+    @accept_label: String?
     @metrics: Array[singleton(Metric)]
     @in_workers: Array[^(Stops stops) -> void]
     @hooks: Hash[Symbol, Array[hook]]
@@ -67,6 +76,33 @@ module Duel
     # Sets #comment, or fails for a value it doesn't take.
     def comment=: (untyped mode) -> untyped
 
+    # Which runs a regression fails: :every_run (the default), or
+    # :pull_requests.
+    attr_reader fail_on: fail_on
+
+    # The values #fail_on takes.
+    FAIL_ON: Array[fail_on]
+
+    # Sets #fail_on, or fails for a value it doesn't take.
+    def fail_on=: (untyped runs) -> untyped
+
+    # The name of a label that accepts a regression in a pull request, or
+    # nil (the default) for none.
+    attr_reader accept_label: String?
+
+    # Sets #accept_label, or fails for what isn't a name or nil.
+    def accept_label=: (untyped label) -> untyped
+
+    # What a push is compared with: :before (the default), the commit
+    # before it, or :last_passed, the last commit Duel passed.
+    attr_reader push_base: push_base
+
+    # The values #push_base takes.
+    PUSH_BASES: Array[push_base]
+
+    # Sets #push_base, or fails for a value it doesn't take.
+    def push_base=: (untyped base) -> untyped
+
     # What #prepare was given, by scope.
     # @api private
     attr_reader prepares: Hash[Symbol, Array[prepare]]

data/sig/duel/init.rbs

@@ -21,6 +21,7 @@ module Duel
     @root: String
     @force: bool?
     @dry_run: bool?
+    @gitlab: bool?
     @stackprof: bool?
 
     def initialize: (Array[String] argv, ?out: _Output, ?err: _Output, ?root: String) -> void
@@ -99,5 +100,17 @@ module Duel
 
     # What marks the workflow's comment on a pull request.
     def marker: () -> String
+
+    # The branch that marks the last commit Duel passed in a push.
+    def passed_branch: () -> String
+
+    # Where the GitLab CI jobs are, from the repository's root.
+    def gitlab_file: () -> String
+
+    # The GitLab CI job's name.
+    def gitlab_job: () -> String
+
+    # The Ruby image's tag for GitLab CI.
+    def gitlab_ruby: () -> String
   end
 end

data/sig/duel/runner.rbs

@@ -18,7 +18,7 @@ module Duel
 
   # How a run is set up (see Duel::CLI for where each comes from).
   # @api private
-  class Settings < Struct[String | Regexp | Integer | Float | bool | Config::ruby | Config::comment | nil]
+  class Settings < Struct[String | Regexp | Integer | Float | bool | Config::ruby | Config::comment | Config::fail_on | nil]
     attr_accessor base: String?
     attr_accessor base_dir: String?
     attr_accessor candidate_dir: String?
@@ -36,13 +36,25 @@ module Duel
     # When the workflow comments on a pull request (--comment), over
     # Config#comment.
     attr_accessor comment: Config::comment?
+    # Which runs a regression fails (--fail-on), over Config#fail_on.
+    attr_accessor fail_on: Config::fail_on?
+    # The branch pushed, where #base is the push's, the commit before it,
+    # on GitHub Actions (DUEL_BASE): see Baseline#ref.
+    attr_accessor pushed: String?
+    # The branch a pull request targets, on GitHub Actions
+    # (GITHUB_BASE_REF), on origin: see Baseline#main_branch.
+    attr_accessor target: String?
 
     def self.new: (?String? base, ?String? base_dir, ?String? candidate_dir, ?Regexp filter, ?Integer jobs,
                    ?Integer processes, ?Float limit, ?Float confidence, ?Float? warm, ?bool force, ?String? config_path,
-                   ?Float timeout, ?Config::ruby ruby, ?Config::comment? comment) -> instance
+                   ?Float timeout, ?Config::ruby ruby, ?Config::comment? comment,
+                   ?Config::fail_on? fail_on, ?String? pushed,
+                   ?String? target) -> instance
                 | (?base: String?, ?base_dir: String?, ?candidate_dir: String?, ?filter: Regexp, ?jobs: Integer,
                    ?processes: Integer, ?limit: Float, ?confidence: Float, ?warm: Float?, ?force: bool,
-                   ?config_path: String?, ?timeout: Float, ?ruby: Config::ruby, ?comment: Config::comment?) -> instance
+                   ?config_path: String?, ?timeout: Float, ?ruby: Config::ruby, ?comment: Config::comment?,
+                   ?fail_on: Config::fail_on?, ?pushed: String?,
+                   ?target: String?) -> instance
 
     def self.defaults: () -> Settings
   end

data/sig/duel/summary.rbs

@@ -25,6 +25,7 @@ module Duel
     # How Duel decides that a timing is slower, in its docs.
     DECIDES: String
 
+    @note: String?
     @runner: Runner
     @results: Array[Result]
     @settings: Settings
@@ -51,7 +52,8 @@ module Duel
     # The counted measures that differ, an iteration.
     def self.changed_counts: (Result result) -> Hash[String, [Float, Float]]
 
-    def initialize: (Runner runner, Array[Result] results, settings: Settings, baseline: String, candidate: String) -> void
+    def initialize: (Runner runner, Array[Result] results, settings: Settings, baseline: String, candidate: String,
+                    ?note: String?) -> void
 
     # The Markdown.
     def markdown: () -> String

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: duel
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Erik Berlin
@@ -68,7 +68,9 @@ files:
 - lib/duel/stats.rb
 - lib/duel/summary.rb
 - lib/duel/templates/benchmark_duel.rb.erb
+- lib/duel/templates/duel.gitlab-ci.yml.erb
 - lib/duel/templates/duel.rb.erb
+- lib/duel/templates/perf-comment.yml.erb
 - lib/duel/templates/perf.yml.erb
 - lib/duel/testing.rb
 - lib/duel/version.rb