toys-ci 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 33be1026b282eba5ffd250b26046e6de597db1ca2330ffb076c38e906a204bd0
4
- data.tar.gz: 0d3ef0fc6fc1b0a348ee9754f2ed62a3b7880f7785c539d7411e838961a60702
3
+ metadata.gz: 930f8dd02101b632b43de132bdb4cd9bb5dc5a322ce439237ab9a196f63b8af7
4
+ data.tar.gz: 2ff9f4e94186f53de050cf887ada97be286a468715e4c246306c10aa9f7e9feb
5
5
  SHA512:
6
- metadata.gz: c9cde4a096e1d9119ad8995f63cf66073a5ac53ff5f7974ace7c52d979f3177235e78515f6040f541ef29583977c2ab1bcbdb79562938bcf43ad9a966545c108
7
- data.tar.gz: dbbb802c658ca28eba170292ded6f02178293373bcb8ca7ebaad4aa0673d32948dd065493e0819adf363968c4886cae9e02976a6925d673c4332eb47d99fa6ac
6
+ metadata.gz: c4f7724718a3d79c11f18d33101ca1aab775f6e1a989551a262f3ccac7428cc4fe34269cbb3eb782912445eee601d0278e4f0fd22d8791f5a23c47c330bd687e
7
+ data.tar.gz: 7ddcd750e4f5e0fad97e3e14898d40095fa3debf1fcb0b88625126c1ceee889700cf92eb79ba27b3c06e3d8090944e9bd98f2f54720c356dc6124a43a27391c4
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release History
2
2
 
3
+ ### v0.1.1 / 2026-05-05
4
+
5
+ * DOCS: Minor documentation updates
6
+
3
7
  ### v0.1.0 / 2026-03-11
4
8
 
5
9
  * Initial release
data/README.md CHANGED
@@ -20,43 +20,48 @@ and produces a final report of the results.
20
20
 
21
21
  Given the following `.toys.rb`:
22
22
 
23
- # Create a "test" tool that runs minitest-based tests
24
- expand :minitest, bundler: true
25
-
26
- # Create a "rubocop" tool that checks the code base
27
- expand :rubocop, bundler: true
28
-
29
- # Create a "ci" tool that runs the above tools and
30
- # summarizes their results
31
- tool "ci" do
32
- load_gem "toys-ci"
33
-
34
- expand(Toys::CI::Template) do |ci|
35
- ci.only_flag = true
36
- ci.tool_job("Run Rubocop", ["rubocop"], flag: :rubocop)
37
- ci.tool_job("Run tests", ["test"], flag: :tests)
38
- end
39
- end
23
+ ```ruby
24
+ # Create a "test" tool that runs minitest-based tests
25
+ expand :minitest, bundler: true
26
+
27
+ # Create a "rubocop" tool that checks the code base
28
+ expand :rubocop, bundler: true
29
+
30
+ # Create a "ci" tool that runs the above tools and
31
+ # summarizes their results
32
+ tool "ci" do
33
+ load_gem "toys-ci"
34
+
35
+ expand(Toys::CI::Template) do |ci|
36
+ ci.only_flag = true
37
+ ci.tool_job("Run Rubocop", ["rubocop"], flag: :rubocop)
38
+ ci.tool_job("Run tests", ["test"], flag: :tests)
39
+ end
40
+ end
41
+ ```
40
42
 
41
43
  Now you can:
42
44
 
43
- $ toys ci # Runs both jobs
44
- $ toys ci --only --tests # Runs only the tests
45
+ ```
46
+ $ toys ci # Runs both jobs
47
+ $ toys ci --only --tests # Runs only the tests
48
+ ```
45
49
 
46
50
  ### Key features
47
51
 
48
- * Two interfaces: a high level Template interface that generates an entire tool
49
- for you including configuration flags, and a low-level Mixin interface that
50
- provides convenient methods that you can call to write your own CI tool.
52
+ * Two interfaces: a high level Template interface that generates an entire
53
+ tool for you including configuration flags, and a low-level Mixin interface
54
+ that provides convenient methods that you can call to write your own CI
55
+ tool.
51
56
 
52
- * The high-level interface generates flags that allow selection of individual
53
- jobs and groups of jobs to execute.
57
+ * The high-level interface generates flags that allow selection of individual
58
+ jobs and groups of jobs to execute.
54
59
 
55
- * Optionally analyzes diffs and skips jobs that do not need executing because
56
- no relevant changes have occurred.
60
+ * Optionally analyzes diffs and skips jobs that do not need executing because
61
+ no relevant changes have occurred.
57
62
 
58
- * Customize your tool, including implementing additional flags and
59
- functionality, using the power of the Toys framework.
63
+ * Customize your tool, including implementing additional flags and
64
+ functionality, using the power of the Toys framework.
60
65
 
61
66
  ### System requirements
62
67
 
@@ -40,6 +40,25 @@ module Toys
40
40
  class Template
41
41
  include ::Toys::Template
42
42
 
43
+ ##
44
+ # Create the CI template.
45
+ # This template provides no direct arguments.
46
+ # All configuration of this template should be done by calling methods
47
+ # on the template in the expand block.
48
+ #
49
+ def initialize
50
+ @jobs = []
51
+ @collections = []
52
+ @all_flag = nil
53
+ @only_flag = nil
54
+ @jobs_disabled_by_default = nil
55
+ @fail_fast_flag = nil
56
+ @fail_fast_default = false
57
+ @base_ref_flag = nil
58
+ @use_github_base_ref_flag = nil
59
+ @prerun = nil
60
+ end
61
+
43
62
  ##
44
63
  # Add a job implemented by a tool call.
45
64
  #
@@ -273,20 +292,6 @@ module Toys
273
292
  @use_github_base_ref_flag = value
274
293
  end
275
294
 
276
- # @private
277
- def initialize
278
- @jobs = []
279
- @collections = []
280
- @all_flag = nil
281
- @only_flag = nil
282
- @jobs_disabled_by_default = nil
283
- @fail_fast_flag = nil
284
- @fail_fast_default = false
285
- @base_ref_flag = nil
286
- @use_github_base_ref_flag = nil
287
- @prerun = nil
288
- end
289
-
290
295
  # @private
291
296
  BlockJob = ::Struct.new(:name, :flag, :override_flags, :trigger_paths, :block)
292
297
 
@@ -6,6 +6,6 @@ module Toys
6
6
  # Current version of the Toys CI system.
7
7
  # @return [String]
8
8
  #
9
- VERSION = "0.1.0"
9
+ VERSION = "0.1.1"
10
10
  end
11
11
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: toys-ci
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Daniel Azuma
@@ -46,10 +46,10 @@ homepage: https://github.com/dazuma/toys
46
46
  licenses:
47
47
  - MIT
48
48
  metadata:
49
- changelog_uri: https://dazuma.github.io/toys/gems/toys-ci/v0.1.0/file.CHANGELOG.html
50
- source_code_uri: https://github.com/dazuma/toys/tree/toys-ci/v0.1.0/toys-ci
49
+ changelog_uri: https://dazuma.github.io/toys/gems/toys-ci/v0.1.1/file.CHANGELOG.html
50
+ source_code_uri: https://github.com/dazuma/toys/tree/toys-ci/v0.1.1/toys-ci
51
51
  bug_tracker_uri: https://github.com/dazuma/toys/issues
52
- documentation_uri: https://dazuma.github.io/toys/gems/toys-ci/v0.1.0
52
+ documentation_uri: https://dazuma.github.io/toys/gems/toys-ci/v0.1.1
53
53
  rdoc_options: []
54
54
  require_paths:
55
55
  - lib
@@ -64,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
64
64
  - !ruby/object:Gem::Version
65
65
  version: '0'
66
66
  requirements: []
67
- rubygems_version: 4.0.3
67
+ rubygems_version: 4.0.6
68
68
  specification_version: 4
69
69
  summary: CI system using GitHub Actions and Toys
70
70
  test_files: []