rake_github 0.8.0.pre.11 → 0.10.0.pre.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.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +38 -36
  3. data/README.md +63 -1
  4. data/Rakefile +3 -1
  5. data/lib/rake_github/version.rb +1 -1
  6. metadata +48 -48
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 649efb9262692c94cea8cb666173fafec80461322a248d4b639f3788816b0532
4
- data.tar.gz: 0cffc7541a38dfe8ed2669bc708c183f822d8ff1f42916e2898dd6f8a4b03233
3
+ metadata.gz: dcfac9d4a7d81f86994bc3f46fda5a40cfbcc51781b97d6fb77b592ec40b1262
4
+ data.tar.gz: 5a28175ee6e3e2f4f45e65dbbbf0c0c31e78cf2f503f879b34fb48af6ad59ac7
5
5
  SHA512:
6
- metadata.gz: 0f94e3e75e6c3486022f0c955e7885e17fe0715e612a6b8ed74ddf00b2cf6563ceaf0398509700b7bdb1e506f449ec40660dbd7f0f8c3c99b5046e63129787b2
7
- data.tar.gz: d5d5f06e6ea1677dce461000a3f7c7c533792762777f1fe28ed2dfe446f06be78a53f93eb07c55f0563bc4aa7a76a0c30ffe2fed4ca0bae1863d4f2cf755b4ab
6
+ metadata.gz: 0d745585a8e3c1efa4d2a4239d292cd4002a4741687f17547c1190a4a1aa2c0fc17175208036aff1394cd422ce680e18263bc86170c18e580480080c510ff229
7
+ data.tar.gz: 1fcfa3d2f63c6800e779cf3c30b38059c74b306aec320dec78e9236c9e4fea62220c2b4296ec0c4eab022ec2d6654b236402ba017f570890f2ecba04cfb1093d
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- rake_github (0.8.0.pre.11)
4
+ rake_github (0.10.0.pre.1)
5
5
  colored2 (~> 3.1)
6
6
  octokit (~> 4.16)
7
7
  rake_factory (~> 0.23)
@@ -10,50 +10,53 @@ PATH
10
10
  GEM
11
11
  remote: https://rubygems.org/
12
12
  specs:
13
- activesupport (6.1.4.1)
13
+ activesupport (7.0.2.3)
14
14
  concurrent-ruby (~> 1.0, >= 1.0.2)
15
15
  i18n (>= 1.6, < 2)
16
16
  minitest (>= 5.1)
17
17
  tzinfo (~> 2.0)
18
- zeitwerk (~> 2.3)
19
18
  addressable (2.8.0)
20
19
  public_suffix (>= 2.0.2, < 5.0)
21
20
  colored2 (3.1.2)
22
21
  concurrent-ruby (1.1.9)
23
- diff-lcs (1.4.4)
22
+ diff-lcs (1.5.0)
24
23
  docile (1.4.0)
25
- excon (0.85.0)
26
- faraday (1.7.0)
24
+ excon (0.92.0)
25
+ faraday (1.10.0)
27
26
  faraday-em_http (~> 1.0)
28
27
  faraday-em_synchrony (~> 1.0)
29
28
  faraday-excon (~> 1.1)
30
- faraday-httpclient (~> 1.0.1)
29
+ faraday-httpclient (~> 1.0)
30
+ faraday-multipart (~> 1.0)
31
31
  faraday-net_http (~> 1.0)
32
- faraday-net_http_persistent (~> 1.1)
32
+ faraday-net_http_persistent (~> 1.0)
33
33
  faraday-patron (~> 1.0)
34
34
  faraday-rack (~> 1.0)
35
- multipart-post (>= 1.2, < 3)
35
+ faraday-retry (~> 1.0)
36
36
  ruby2_keywords (>= 0.0.4)
37
37
  faraday-em_http (1.0.0)
38
38
  faraday-em_synchrony (1.0.0)
39
39
  faraday-excon (1.1.0)
40
40
  faraday-httpclient (1.0.1)
41
+ faraday-multipart (1.0.3)
42
+ multipart-post (>= 1.2, < 3)
41
43
  faraday-net_http (1.0.1)
42
44
  faraday-net_http_persistent (1.2.0)
43
45
  faraday-patron (1.0.0)
44
46
  faraday-rack (1.0.0)
47
+ faraday-retry (1.0.3)
45
48
  gem-release (2.2.2)
46
49
  hamster (3.0.0)
47
50
  concurrent-ruby (~> 1.0)
48
- i18n (1.8.11)
51
+ i18n (1.10.0)
49
52
  concurrent-ruby (~> 1.0)
50
53
  lino (3.0.0)
51
54
  hamster (~> 3.0)
52
55
  open4 (~> 1.3)
53
56
  memfs (1.0.0)
54
- minitest (5.14.4)
57
+ minitest (5.15.0)
55
58
  multipart-post (2.1.1)
56
- octokit (4.21.0)
59
+ octokit (4.22.0)
57
60
  faraday (>= 0.9)
58
61
  sawyer (~> 0.8.0, >= 0.5.3)
59
62
  open4 (1.3.4)
@@ -74,19 +77,19 @@ GEM
74
77
  colored2 (~> 3.1)
75
78
  rake_factory (~> 0.23)
76
79
  sshkey (~> 2.0)
77
- rspec (3.10.0)
78
- rspec-core (~> 3.10.0)
79
- rspec-expectations (~> 3.10.0)
80
- rspec-mocks (~> 3.10.0)
81
- rspec-core (3.10.1)
82
- rspec-support (~> 3.10.0)
83
- rspec-expectations (3.10.1)
80
+ rspec (3.11.0)
81
+ rspec-core (~> 3.11.0)
82
+ rspec-expectations (~> 3.11.0)
83
+ rspec-mocks (~> 3.11.0)
84
+ rspec-core (3.11.0)
85
+ rspec-support (~> 3.11.0)
86
+ rspec-expectations (3.11.0)
84
87
  diff-lcs (>= 1.2.0, < 2.0)
85
- rspec-support (~> 3.10.0)
86
- rspec-mocks (3.10.2)
88
+ rspec-support (~> 3.11.0)
89
+ rspec-mocks (3.11.0)
87
90
  diff-lcs (>= 1.2.0, < 2.0)
88
- rspec-support (~> 3.10.0)
89
- rspec-support (3.10.2)
91
+ rspec-support (~> 3.11.0)
92
+ rspec-support (3.11.0)
90
93
  ruby2_keywords (0.0.5)
91
94
  ruby_gpg2 (0.8.0)
92
95
  lino (>= 1.5)
@@ -98,27 +101,26 @@ GEM
98
101
  simplecov-html (~> 0.11)
99
102
  simplecov_json_formatter (~> 0.1)
100
103
  simplecov-html (0.12.3)
101
- simplecov_json_formatter (0.1.3)
104
+ simplecov_json_formatter (0.1.4)
102
105
  sshkey (2.0.0)
103
106
  tzinfo (2.0.4)
104
107
  concurrent-ruby (~> 1.0)
105
- zeitwerk (2.5.1)
106
108
 
107
109
  PLATFORMS
108
110
  ruby
109
111
 
110
112
  DEPENDENCIES
111
- activesupport (~> 6.1)
112
- bundler (~> 2.0)
113
- gem-release (~> 2.0)
114
- memfs (~> 1.0)
115
- rake (~> 13.0)
116
- rake_circle_ci (~> 0.9)
113
+ activesupport
114
+ bundler
115
+ gem-release
116
+ memfs
117
+ rake
118
+ rake_circle_ci
117
119
  rake_github!
118
- rake_gpg (~> 0.12)
119
- rake_ssh (~> 0.4)
120
- rspec (~> 3.9)
121
- simplecov (~> 0.16)
120
+ rake_gpg
121
+ rake_ssh
122
+ rspec
123
+ simplecov
122
124
 
123
125
  BUNDLED WITH
124
- 2.3.6
126
+ 2.3.9
data/README.md CHANGED
@@ -20,7 +20,69 @@ Or install it yourself as:
20
20
 
21
21
  ## Usage
22
22
 
23
- TODO: Write usage instructions here
23
+ ### define_deploy_keys_tasks
24
+
25
+ ### define_repository_tasks
26
+
27
+ Sets up rake tasks for managing deploy keys and merging pull requests.
28
+
29
+ ```ruby
30
+ require 'rake_github'
31
+
32
+ RakeGithub.define_repository_tasks(
33
+ namespace: :github,
34
+ repository: 'org/repo', # required
35
+ ) do |t, args|
36
+ t.access_token = "your_github_access_token" # required
37
+ t.deploy_keys = [
38
+ {
39
+ title: 'CircleCI',
40
+ public_key: File.read('path/to/your_deploy_key.public')
41
+ }
42
+ ]
43
+ t.branch_name = args.branch_name
44
+ t.commit_message = args.commit_message
45
+ end
46
+ ```
47
+
48
+ | Parameter | Type | Required | Description | Example | Default |
49
+ |---------------------------------|--------|----------|------------------------------------------------------------|--------------------------------------------------------|--------------------------------------|
50
+ | repository | string | Y | Repository to perform tasks upon | 'organisation/repository_name' | N/A |
51
+ | access_token | string | Y | Github token for authorisation | 'ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' | N/A |
52
+ | deploy_keys | array | N | Keys to deploy to repository | { title: string, public_key: string, read_only: bool } | [ ] |
53
+ | deploy_keys_namespace | symbol | N | Namespace to contain deploy keys tasks | :deploy_tasks | :deploy_keys |
54
+ | deploy_keys_destroy_task_name | symbol | N | Option to change the destroy task name | :obliterate | :destroy |
55
+ | deploy_keys_provision_task_name | symbol | N | Option to change the provision task name | :add | :provision |
56
+ | deploy_keys_ensure_task_name | symbol | N | Option to change the ensure task name | :destroy_and_provision | :ensure |
57
+ | namespace | symbol | N | Namespace for tasks to live in, defaults to root namespace | :rake_github | N/A |
58
+ | branch_name | string | N | Branch that can be merged | 'cool_new_feature' | N/A |
59
+ | commit_message | string | N | Merge commit message | 'merged PR using Rake Github' | "" (retains original commit message) |
60
+
61
+ Exposes tasks:
62
+ ```shell
63
+ $ rake -T
64
+
65
+ rake github:deploy_keys:destroy
66
+ rake github:deploy_keys:ensure
67
+ rake github:deploy_keys:provision
68
+ rake github:pull_requests:merge[branch_name,commit_message]
69
+ ```
70
+
71
+ #### deploy_keys:provision
72
+ Provisions deploy keys to the specified repository.
73
+
74
+ #### deploy_keys:destroy
75
+ Destroys deploy keys from the specified repository.
76
+
77
+ #### deploy_keys:ensure
78
+ Destroys and then provisions deploy keys on the specified repository.
79
+
80
+ #### pull_requests:merge[branch_name,commit_message]
81
+ Merges the PR associated with the `branch_name`. Branch name is required.
82
+
83
+ `commit_message` is optional, and can contain the original commit message with the `%s` placeholder, e.g. `pull_requests:merge[new_feature,"%s [skip ci]"]`.
84
+
85
+ ### define_release_task
24
86
 
25
87
  ## Development
26
88
 
data/Rakefile CHANGED
@@ -62,7 +62,7 @@ end
62
62
  RakeGithub.define_repository_tasks(
63
63
  namespace: :github,
64
64
  repository: 'infrablocks/rake_github',
65
- ) do |t|
65
+ ) do |t, args|
66
66
  github_config =
67
67
  YAML.load_file('config/secrets/github/config.yaml')
68
68
 
@@ -73,6 +73,8 @@ RakeGithub.define_repository_tasks(
73
73
  public_key: File.read('config/secrets/ci/ssh.public')
74
74
  }
75
75
  ]
76
+ t.branch_name = args.branch_name
77
+ t.commit_message = args.commit_message
76
78
  end
77
79
 
78
80
  namespace :pipeline do
data/lib/rake_github/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module RakeGithub
2
- VERSION = '0.8.0.pre.11'
2
+ VERSION = '0.10.0.pre.1'
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rake_github
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.8.0.pre.11
4
+ version: 0.10.0.pre.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - InfraBlocks Maintainers
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2022-01-27 00:00:00.000000000 Z
11
+ date: 2022-03-13 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: colored2
@@ -70,156 +70,156 @@ dependencies:
70
70
  name: activesupport
71
71
  requirement: !ruby/object:Gem::Requirement
72
72
  requirements:
73
- - - "~>"
73
+ - - ">="
74
74
  - !ruby/object:Gem::Version
75
- version: '6.1'
75
+ version: '0'
76
76
  type: :development
77
77
  prerelease: false
78
78
  version_requirements: !ruby/object:Gem::Requirement
79
79
  requirements:
80
- - - "~>"
80
+ - - ">="
81
81
  - !ruby/object:Gem::Version
82
- version: '6.1'
82
+ version: '0'
83
83
  - !ruby/object:Gem::Dependency
84
84
  name: bundler
85
85
  requirement: !ruby/object:Gem::Requirement
86
86
  requirements:
87
- - - "~>"
87
+ - - ">="
88
88
  - !ruby/object:Gem::Version
89
- version: '2.0'
89
+ version: '0'
90
90
  type: :development
91
91
  prerelease: false
92
92
  version_requirements: !ruby/object:Gem::Requirement
93
93
  requirements:
94
- - - "~>"
94
+ - - ">="
95
95
  - !ruby/object:Gem::Version
96
- version: '2.0'
96
+ version: '0'
97
97
  - !ruby/object:Gem::Dependency
98
98
  name: gem-release
99
99
  requirement: !ruby/object:Gem::Requirement
100
100
  requirements:
101
- - - "~>"
101
+ - - ">="
102
102
  - !ruby/object:Gem::Version
103
- version: '2.0'
103
+ version: '0'
104
104
  type: :development
105
105
  prerelease: false
106
106
  version_requirements: !ruby/object:Gem::Requirement
107
107
  requirements:
108
- - - "~>"
108
+ - - ">="
109
109
  - !ruby/object:Gem::Version
110
- version: '2.0'
110
+ version: '0'
111
111
  - !ruby/object:Gem::Dependency
112
112
  name: memfs
113
113
  requirement: !ruby/object:Gem::Requirement
114
114
  requirements:
115
- - - "~>"
115
+ - - ">="
116
116
  - !ruby/object:Gem::Version
117
- version: '1.0'
117
+ version: '0'
118
118
  type: :development
119
119
  prerelease: false
120
120
  version_requirements: !ruby/object:Gem::Requirement
121
121
  requirements:
122
- - - "~>"
122
+ - - ">="
123
123
  - !ruby/object:Gem::Version
124
- version: '1.0'
124
+ version: '0'
125
125
  - !ruby/object:Gem::Dependency
126
126
  name: rake
127
127
  requirement: !ruby/object:Gem::Requirement
128
128
  requirements:
129
- - - "~>"
129
+ - - ">="
130
130
  - !ruby/object:Gem::Version
131
- version: '13.0'
131
+ version: '0'
132
132
  type: :development
133
133
  prerelease: false
134
134
  version_requirements: !ruby/object:Gem::Requirement
135
135
  requirements:
136
- - - "~>"
136
+ - - ">="
137
137
  - !ruby/object:Gem::Version
138
- version: '13.0'
138
+ version: '0'
139
139
  - !ruby/object:Gem::Dependency
140
140
  name: rake_circle_ci
141
141
  requirement: !ruby/object:Gem::Requirement
142
142
  requirements:
143
- - - "~>"
143
+ - - ">="
144
144
  - !ruby/object:Gem::Version
145
- version: '0.9'
145
+ version: '0'
146
146
  type: :development
147
147
  prerelease: false
148
148
  version_requirements: !ruby/object:Gem::Requirement
149
149
  requirements:
150
- - - "~>"
150
+ - - ">="
151
151
  - !ruby/object:Gem::Version
152
- version: '0.9'
152
+ version: '0'
153
153
  - !ruby/object:Gem::Dependency
154
154
  name: rake_github
155
155
  requirement: !ruby/object:Gem::Requirement
156
156
  requirements:
157
- - - "~>"
157
+ - - ">="
158
158
  - !ruby/object:Gem::Version
159
- version: '0.5'
159
+ version: '0'
160
160
  type: :development
161
161
  prerelease: false
162
162
  version_requirements: !ruby/object:Gem::Requirement
163
163
  requirements:
164
- - - "~>"
164
+ - - ">="
165
165
  - !ruby/object:Gem::Version
166
- version: '0.5'
166
+ version: '0'
167
167
  - !ruby/object:Gem::Dependency
168
168
  name: rake_gpg
169
169
  requirement: !ruby/object:Gem::Requirement
170
170
  requirements:
171
- - - "~>"
171
+ - - ">="
172
172
  - !ruby/object:Gem::Version
173
- version: '0.12'
173
+ version: '0'
174
174
  type: :development
175
175
  prerelease: false
176
176
  version_requirements: !ruby/object:Gem::Requirement
177
177
  requirements:
178
- - - "~>"
178
+ - - ">="
179
179
  - !ruby/object:Gem::Version
180
- version: '0.12'
180
+ version: '0'
181
181
  - !ruby/object:Gem::Dependency
182
182
  name: rake_ssh
183
183
  requirement: !ruby/object:Gem::Requirement
184
184
  requirements:
185
- - - "~>"
185
+ - - ">="
186
186
  - !ruby/object:Gem::Version
187
- version: '0.4'
187
+ version: '0'
188
188
  type: :development
189
189
  prerelease: false
190
190
  version_requirements: !ruby/object:Gem::Requirement
191
191
  requirements:
192
- - - "~>"
192
+ - - ">="
193
193
  - !ruby/object:Gem::Version
194
- version: '0.4'
194
+ version: '0'
195
195
  - !ruby/object:Gem::Dependency
196
196
  name: rspec
197
197
  requirement: !ruby/object:Gem::Requirement
198
198
  requirements:
199
- - - "~>"
199
+ - - ">="
200
200
  - !ruby/object:Gem::Version
201
- version: '3.9'
201
+ version: '0'
202
202
  type: :development
203
203
  prerelease: false
204
204
  version_requirements: !ruby/object:Gem::Requirement
205
205
  requirements:
206
- - - "~>"
206
+ - - ">="
207
207
  - !ruby/object:Gem::Version
208
- version: '3.9'
208
+ version: '0'
209
209
  - !ruby/object:Gem::Dependency
210
210
  name: simplecov
211
211
  requirement: !ruby/object:Gem::Requirement
212
212
  requirements:
213
- - - "~>"
213
+ - - ">="
214
214
  - !ruby/object:Gem::Version
215
- version: '0.16'
215
+ version: '0'
216
216
  type: :development
217
217
  prerelease: false
218
218
  version_requirements: !ruby/object:Gem::Requirement
219
219
  requirements:
220
- - - "~>"
220
+ - - ">="
221
221
  - !ruby/object:Gem::Version
222
- version: '0.16'
222
+ version: '0'
223
223
  description: Allows managing repository deploy keys.
224
224
  email:
225
225
  - maintainers@infrablocks.io
@@ -261,14 +261,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
261
261
  requirements:
262
262
  - - ">="
263
263
  - !ruby/object:Gem::Version
264
- version: '2.6'
264
+ version: '2.7'
265
265
  required_rubygems_version: !ruby/object:Gem::Requirement
266
266
  requirements:
267
267
  - - ">"
268
268
  - !ruby/object:Gem::Version
269
269
  version: 1.3.1
270
270
  requirements: []
271
- rubygems_version: 3.0.1
271
+ rubygems_version: 3.1.6
272
272
  signing_key:
273
273
  specification_version: 4
274
274
  summary: Rake tasks for managing Github repositories.