discharger 0.3.2 → 0.3.3
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 +4 -4
- data/CHANGELOG.md +6 -6
- data/README.md +45 -0
- data/lib/discharger/task.rb +31 -2
- data/lib/discharger/version.rb +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 22ff9b0cc383ea213a6a8766f713ef4afa97a114c679c76b37954f73872b74e3
|
|
4
|
+
data.tar.gz: a3cfa43c5c9665704e13bce7a3bb19e36ccd4810b700b149a2646815fcca9f6a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 0e01ea39ed9eba5c973951784d44b5488a1f6f00effc59a1192d5f1f3cfd2aafbe14895a1d6ce920520acb7c501bc79720febc7360bed35a301c742ab30728ad
|
|
7
|
+
data.tar.gz: 309f1fd0b7ea3d78814aedd8c8bb945e0c63806260007dc8391126863254d4f19d87adc0e9ec7cdd584c3173982fd69465e87c06a13a97f90870aa60d93b2f6d
|
data/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](http://keepachangelog.com/)
|
|
6
6
|
and this project adheres to [Semantic Versioning](http://semver.org/).
|
|
7
7
|
|
|
8
|
+
## [0.3.3] - 2026-07-22
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
|
|
12
|
+
- Post-release runbook announcement in the Slack release thread, from Reissue's runbook_file (0cf9620)
|
|
13
|
+
|
|
8
14
|
## [0.3.2] - 2026-07-15
|
|
9
15
|
|
|
10
16
|
### Changed
|
|
@@ -15,9 +21,3 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
|
|
|
15
21
|
|
|
16
22
|
- Retry `brew bundle` once before failing setup, so transient Homebrew lock contention (e.g. two `bin/setup` runs on the same host) doesn't hard-fail the whole run.
|
|
17
23
|
- pg-tools wrappers no longer forward localhost -h/-p flags into docker exec, where the host-mapped port doesn't exist; remote hosts still pass through untouched (a3869d2)
|
|
18
|
-
|
|
19
|
-
## [0.3.1] - 2026-05-13
|
|
20
|
-
|
|
21
|
-
### Added
|
|
22
|
-
|
|
23
|
-
- database.prefer_docker setup.yml option for explicit Docker vs native PostgreSQL selection (2fca81e)
|
data/README.md
CHANGED
|
@@ -89,6 +89,51 @@ changelog.d/
|
|
|
89
89
|
|
|
90
90
|
Each fragment file should contain the changelog entry for a specific change or feature.
|
|
91
91
|
|
|
92
|
+
### Post-release Runbook
|
|
93
|
+
|
|
94
|
+
Some releases need manual follow-up: run a rake task, backfill data, re-index documents.
|
|
95
|
+
Reissue collects those steps from `Runbook:` commit trailers, and Discharger announces
|
|
96
|
+
them to your team in the release thread.
|
|
97
|
+
|
|
98
|
+
```ruby
|
|
99
|
+
Discharger::Task.create do |task|
|
|
100
|
+
# ... other configuration ...
|
|
101
|
+
task.runbook_file = "RUNBOOK.md" # Default: nil (disabled)
|
|
102
|
+
end
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
Add steps as you work, in the same commit as the change that requires them:
|
|
106
|
+
|
|
107
|
+
```bash
|
|
108
|
+
git commit -m "Add data migration
|
|
109
|
+
|
|
110
|
+
Fixed: Duplicate user records
|
|
111
|
+
Runbook: Run \`rake data:cleanup\` after deploy"
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
`rake release:prepare` finalizes the runbook alongside the changelog, so the release tag
|
|
115
|
+
records exactly which steps that version needs. After the production release, Discharger
|
|
116
|
+
posts the checklist to Slack as a reply in the release thread, right after the changelog:
|
|
117
|
+
|
|
118
|
+
```
|
|
119
|
+
*Post-release runbook for 1.2.3* — 2 steps
|
|
120
|
+
|
|
121
|
+
• Run `rake data:cleanup` (abc1234)
|
|
122
|
+
• Re-index search documents (def5678)
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
When a release needs no follow-up, the thread says so explicitly rather than staying
|
|
126
|
+
silent, so nobody has to wonder whether the check was skipped:
|
|
127
|
+
|
|
128
|
+
```
|
|
129
|
+
*Post-release runbook for 1.2.3*
|
|
130
|
+
No runbook tasks for this release.
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
Leave `runbook_file` unset and Discharger posts nothing extra. See the
|
|
134
|
+
[Reissue runbook documentation](https://github.com/SOFware/reissue#post-release-runbook)
|
|
135
|
+
for how items are collected and merged.
|
|
136
|
+
|
|
92
137
|
## Available Tasks
|
|
93
138
|
|
|
94
139
|
The gem creates several Rake tasks for managing your deployment workflow:
|
data/lib/discharger/task.rb
CHANGED
|
@@ -24,6 +24,7 @@ module Discharger
|
|
|
24
24
|
reissue.fragment = task.fragment
|
|
25
25
|
reissue.clear_fragments = task.clear_fragments
|
|
26
26
|
reissue.tag_pattern = task.tag_pattern
|
|
27
|
+
reissue.runbook_file = task.runbook_file
|
|
27
28
|
end
|
|
28
29
|
task.define
|
|
29
30
|
task
|
|
@@ -179,6 +180,27 @@ module Discharger
|
|
|
179
180
|
stdout.strip
|
|
180
181
|
end
|
|
181
182
|
|
|
183
|
+
# The post-release steps collected from "Runbook:" commit trailers.
|
|
184
|
+
# Empty when no runbook is configured or the file has yet to be written.
|
|
185
|
+
def runbook_items
|
|
186
|
+
return [] unless runbook_file
|
|
187
|
+
|
|
188
|
+
Reissue::Runbook.new(Rails.root.join(runbook_file).to_s).items
|
|
189
|
+
end
|
|
190
|
+
|
|
191
|
+
# Build the Slack message listing the post-release steps for a version.
|
|
192
|
+
# Returns nil when the project does not use a runbook, which is distinct
|
|
193
|
+
# from a configured runbook that happens to have no steps this release.
|
|
194
|
+
def runbook_announcement(version, items = runbook_items)
|
|
195
|
+
return nil unless runbook_file
|
|
196
|
+
|
|
197
|
+
header = "*Post-release runbook for #{version}*"
|
|
198
|
+
return "#{header}\nNo runbook tasks for this release." if items.empty?
|
|
199
|
+
|
|
200
|
+
"#{header} — #{items.size} step#{"s" unless items.size == 1}\n\n" +
|
|
201
|
+
items.map { |item| "• #{item}" }.join("\n")
|
|
202
|
+
end
|
|
203
|
+
|
|
182
204
|
def existing_pr_number(base, head)
|
|
183
205
|
stdout, _, status = Open3.capture3(
|
|
184
206
|
"gh", "pr", "list",
|
|
@@ -286,10 +308,17 @@ module Discharger
|
|
|
286
308
|
["git push origin v#{current_version}"]
|
|
287
309
|
) do
|
|
288
310
|
tasker["#{name}:slack"].invoke("Released #{app_name} #{current_version} (#{commit_identifier.call}) to production.", release_message_channel, ":chipmunk:")
|
|
289
|
-
|
|
311
|
+
# Capture the root before replying; each post overwrites last_message_ts.
|
|
312
|
+
thread_ts = last_message_ts
|
|
313
|
+
if thread_ts.present?
|
|
290
314
|
text = File.read(Rails.root.join(changelog_file))
|
|
291
315
|
tasker["#{name}:slack"].reenable
|
|
292
|
-
tasker["#{name}:slack"].invoke(text, release_message_channel, ":log:",
|
|
316
|
+
tasker["#{name}:slack"].invoke(text, release_message_channel, ":log:", thread_ts)
|
|
317
|
+
|
|
318
|
+
if (runbook_message = runbook_announcement(current_version))
|
|
319
|
+
tasker["#{name}:slack"].reenable
|
|
320
|
+
tasker["#{name}:slack"].invoke(runbook_message, release_message_channel, ":clipboard:", thread_ts)
|
|
321
|
+
end
|
|
293
322
|
end
|
|
294
323
|
# Signal success — no branch switch needed since we stay on working_branch throughout
|
|
295
324
|
true
|
data/lib/discharger/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: discharger
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.3.
|
|
4
|
+
version: 0.3.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Jim Gay
|
|
@@ -72,14 +72,14 @@ dependencies:
|
|
|
72
72
|
requirements:
|
|
73
73
|
- - ">="
|
|
74
74
|
- !ruby/object:Gem::Version
|
|
75
|
-
version: '0'
|
|
75
|
+
version: '0.5'
|
|
76
76
|
type: :runtime
|
|
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: '0'
|
|
82
|
+
version: '0.5'
|
|
83
83
|
- !ruby/object:Gem::Dependency
|
|
84
84
|
name: slack-ruby-client
|
|
85
85
|
requirement: !ruby/object:Gem::Requirement
|