Skip to content

A platform for community discussion. Free, open, simple.

DEV: task to update security advisory version info (#38327)

Joffrey JAFFEUX1bed6d8cad9c
diff --git a/lib/release_utils.rb b/lib/release_utils.rb
index c22049929f2..1ca1c3db053 100644
--- a/lib/release_utils.rb
+++ b/lib/release_utils.rb
@@ -98,10 +98,30 @@ module ReleaseUtils
stdout
end
- def self.gh(*args)
+ def self.gh(*args, capture: false, input: nil)
puts "> gh #{args.inspect}"
- return true if test_mode?
- system "gh", *args
+ return true if test_mode? && !capture
+
+ if capture
+ stdout_text, stderr_text, status = Open3.capture3("gh", *args, stdin_data: input)
+
+ return stdout_text if status.success?
+
+ raise <<~MESSAGE
+ gh failed with status #{status.exitstatus}
+ Command: gh #{args.join(" ")}
+ STDOUT:
+ #{stdout_text}
+ STDERR:
+ #{stderr_text}
+ MESSAGE
+ else
+ system "gh", *args
+ end
+ end
+
+ def self.supported_version_info
+ read_versions_json.select { |_version, info| info["supported"] }
end
def self.ref_exists?(ref)
diff --git a/lib/tasks/release.rake b/lib/tasks/release.rake
index 9fcfa11cba5..41a5d735c03 100644
--- a/lib/tasks/release.rake
+++ b/lib/tasks/release.rake
@@ -293,4 +293,111 @@ namespace :release do
end
end
end
+
+ desc "Update advisory affected versions on GitHub for all supported Discourse versions"
+ task "update_security_advisories" do
+ advisories_base = "repos/discourse/discourse/security-advisories"
+
+ puts "Fetching draft security advisories..."
+ pages =
+ JSON.parse(
+ ReleaseUtils.gh(
+ "api",
+ "#{advisories_base}?state=draft",
+ "--paginate",
+ "--slurp",
+ capture: true,
+ ),
+ )
+ advisories = pages.flat_map { |page| page.is_a?(Array) ? page : [page] }
+
+ draft_advisories =
+ advisories.reject { |advisory| advisory.fetch("summary").start_with?("DRAFT") }
+
+ if draft_advisories.empty?
+ puts "No draft advisories to update."
+ next
+ end
+
+ puts "Found #{draft_advisories.size} draft advisory(ies) to update."
+
+ # Calculate patched versions for all supported versions
+ version_patches = []
+ version_info = ReleaseUtils.supported_version_info
+
+ version_info.each do |series, info|
+ branch = info["released"] ? "release/#{series}" : "main"
+
+ current_version = ReleaseUtils.with_clean_worktree(branch) { ReleaseUtils::Version.current }
+
+ if info["released"]
+ # For released versions, next patch is current patch + 1
+ next_version =
+ "#{current_version.major}.#{current_version.minor}.#{current_version.patch + 1}"
+ version_patches << { series:, patched_version: next_version }
+ puts " #{series}: #{current_version} -> #{next_version}"
+ else
+ # For unreleased (latest/development) version, ask about release type
+ prompt = TTY::Prompt.new
+ release_type =
+ prompt.select(
+ "What type of release for #{series} (currently #{current_version})?",
+ {
+ "Intermediate release (security patch)" => :intermediate,
+ "Monthly release" => :monthly,
+ },
+ )
+
+ next_version =
+ if release_type == :intermediate
+ current_version.next_revision.to_s
+ else
+ "#{current_version.major}.#{current_version.minor}.#{current_version.patch}"
+ end
+
+ version_patches << { series:, patched_version: next_version }
+ puts " #{series}: #{current_version} -> #{next_version} (#{release_type})"
+ end
+ end
+
+ vulnerabilities =
+ version_patches.map.with_index do |entry, index|
+ vulnerable_range = index == 0 ? ">= 0" : ">= #{entry[:series]}.0-latest"
+ {
+ package: {
+ ecosystem: "other",
+ name: "Discourse",
+ },
+ vulnerable_version_range: vulnerable_range,
+ patched_versions: entry[:patched_version],
+ }
+ end
+
+ patched_versions = version_patches.map { |e| e[:patched_version] }
+ puts "\nAdvisories to update:"
+ draft_advisories.each { |a| puts " - #{a.fetch("ghsa_id")}: #{a.fetch("summary")}" }
+ puts "\nPatched versions: #{patched_versions.join(", ")}"
+
+ ReleaseUtils.confirm_or_abort("Proceed with updating #{draft_advisories.size} advisory(ies)?")
+
+ draft_advisories.each do |advisory|
+ ghsa_id = advisory.fetch("ghsa_id")
+ payload = { vulnerabilities: vulnerabilities }
+
+ ReleaseUtils.gh(
+ "api",
+ "#{advisories_base}/#{ghsa_id}",
+ "--method",
+ "PATCH",
+ "--input",
+ "-",
+ capture: true,
+ input: JSON.pretty_generate(payload),
+ )
+
+ puts "Updated #{ghsa_id}"
+ end
+
+ puts "\nDone! Updated #{draft_advisories.size} advisory(ies)."
+ end
end
diff --git a/spec/tasks/release_spec.rb b/spec/tasks/release_spec.rb
index b2688b4950f..61aca2174d5 100644
--- a/spec/tasks/release_spec.rb
+++ b/spec/tasks/release_spec.rb
@@ -584,4 +584,144 @@ RSpec.describe "tasks/release" do
end
end
end
+
+ describe "release:update_security_advisories" do
+ subject(:run_task) do
+ Dir.chdir(local_path) do
+ capture_stdout { invoke_rake_task("release:update_security_advisories") }
+ end
+ end
+
+ let(:draft_advisories) do
+ [
+ { "ghsa_id" => "GHSA-1234-5678-9abc", "state" => "draft", "summary" => "Security issue 1" },
+ { "ghsa_id" => "GHSA-abcd-efgh-ijkl", "state" => "draft", "summary" => "Security issue 2" },
+ ]
+ end
+
+ let(:gh_api_response) { JSON.generate([draft_advisories]) }
+ let(:updated_advisories) { [] }
+
+ before do
+ allow(ReleaseUtils).to receive(:gh) do |*args, **kwargs|
+ if args[0..3] ==
+ %w[api repos/discourse/discourse/security-advisories?state=draft --paginate --slurp]
+ gh_api_response
+ elsif args[0] == "api" && args[1].match?(%r{security-advisories/GHSA-}) &&
+ args[2] == "--method"
+ updated_advisories << JSON.parse(kwargs[:input])
+ "{}"
+ else
+ true
+ end
+ end
+
+ Dir.chdir(origin_path) do
+ git "checkout", "-b", "release/2025.5"
+ File.write("lib/version.rb", fake_version_rb("2025.5.2"))
+ git "add", "lib/version.rb"
+ git "commit", "-m", "version 2025.5.2"
+
+ git "checkout", "-b", "release/2025.6"
+ File.write("lib/version.rb", fake_version_rb("2025.6.0"))
+ git "add", "lib/version.rb"
+ git "commit", "-m", "version 2025.6.0"
+
+ git "checkout", "main"
+ end
+
+ update_versions_json(
+ {
+ "2025.5" => {
+ "released" => true,
+ "supported" => true,
+ },
+ "2025.6" => {
+ "released" => true,
+ "supported" => true,
+ },
+ "2025.12" => {
+ "released" => false,
+ "supported" => true,
+ },
+ },
+ )
+ end
+
+ context "when choosing intermediate release for latest" do
+ before do
+ prompt = instance_double(TTY::Prompt)
+ allow(TTY::Prompt).to receive(:new).and_return(prompt)
+ allow(prompt).to receive(:select).and_return(:intermediate)
+ end
+
+ it "updates advisories with correct patched versions" do
+ run_task
+
+ expect(updated_advisories.size).to eq(2)
+
+ vulnerabilities = updated_advisories.first["vulnerabilities"]
+ expect(vulnerabilities.size).to eq(3)
+
+ expect(vulnerabilities[0]).to include(
+ "vulnerable_version_range" => ">= 0",
+ "patched_versions" => "2025.5.3",
+ )
+ expect(vulnerabilities[1]).to include(
+ "vulnerable_version_range" => ">= 2025.6.0-latest",
+ "patched_versions" => "2025.6.1",
+ )
+ expect(vulnerabilities[2]).to include(
+ "vulnerable_version_range" => ">= 2025.12.0-latest",
+ "patched_versions" => "2025.12.0-latest.1",
+ )
+ end
+ end
+
+ context "when choosing monthly release for latest" do
+ before do
+ prompt = instance_double(TTY::Prompt)
+ allow(TTY::Prompt).to receive(:new).and_return(prompt)
+ allow(prompt).to receive(:select).and_return(:monthly)
+ end
+
+ it "uses the current patch version for latest" do
+ run_task
+
+ vulnerabilities = updated_advisories.first["vulnerabilities"]
+ expect(vulnerabilities[2]).to include(
+ "vulnerable_version_range" => ">= 2025.12.0-latest",
+ "patched_versions" => "2025.12.0",
+ )
+ end
+ end
+
+ context "when there are no draft advisories" do
+ let(:gh_api_response) { JSON.generate([[]]) }
+
+ it "outputs a message and does nothing" do
+ output = run_task
+ expect(output).to include("No draft advisories to update")
+ expect(updated_advisories).to be_empty
+ end
+ end
+
+ context "when advisories have DRAFT summary prefix" do
+ let(:draft_advisories) do
+ [
+ {
+ "ghsa_id" => "GHSA-1234-5678-9abc",
+ "state" => "draft",
+ "summary" => "DRAFT - placeholder",
+ },
+ ]
+ end
+
+ it "skips advisories with DRAFT summary prefix" do
+ output = run_task
+ expect(output).to include("No draft advisories to update")
+ expect(updated_advisories).to be_empty
+ end
+ end
+ end
end