Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
454 changes: 454 additions & 0 deletions .github/scripts/release-version-advisory.rb

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# frozen_string_literal: true

module Foo
# @api public
def self.public_thing(x)
x + 1
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# frozen_string_literal: true

module Foo
# @api private
def self.internal_helper(x)
x * 2
end

# @api public
def self.public_thing(x)
x + 1
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
::notice title=Version advisory::Detected changes suggest 'patch'.


## Version advisory

Range: v0.1.0 → HEAD
Overall suggested bump: **patch**
You selected: `patch`.

| Change | Classification | Evidence | Suggested |
|---|---|---|---|
| Removed `Foo::internal_helper` | internal | annotation `# @api private` at lib/foo.rb:5 | patch |

_Advisory only. Maintainer selects the bump. See ci#369 for the design brief._
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# frozen_string_literal: true

module Foo
# @api public
def self.existing_method(x)
x
end

# @api public
def self.new_public_method(x, y)
x + y
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# frozen_string_literal: true

module Foo
# @api public
def self.existing_method(x)
x
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
::notice title=Version advisory::Detected changes suggest 'minor'. You selected 'patch'. See run summary.


## Version advisory

Range: v0.1.0 → HEAD
Overall suggested bump: **minor**
You selected: `patch`.

| Change | Classification | Evidence | Suggested |
|---|---|---|---|
| Added `Foo::new_public_method` | public | annotation `# @api public` at lib/foo.rb:10 | minor |

_Advisory only. Maintainer selects the bump. See ci#369 for the design brief._
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# frozen_string_literal: true

module Foo
# @api public
def self.public_thing(x)
x * 2
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# frozen_string_literal: true

module Foo
# @api public
def self.public_thing(x)
x + 1
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
::notice title=Version advisory::Detected changes suggest 'unknown'. You selected 'patch'. See run summary.


## Version advisory

Range: v0.1.0 → HEAD
Overall suggested bump: **unknown**
You selected: `patch`.

| Change | Classification | Evidence | Suggested |
|---|---|---|---|
| Body-changed (undetectable) `Foo::public_thing` | public | annotation `# @api public` at lib/foo.rb:5 | unknown |

_Advisory only. Maintainer selects the bump. See ci#369 for the design brief._
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# frozen_string_literal: true

module Foo
# @api public
# Updated comment describing the method a bit more.
def self.method_a(x)
x
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# frozen_string_literal: true

module Foo
# @api public
def self.method_a(x)
x
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
::notice title=Version advisory::Detected changes suggest 'none'. You selected 'patch'. See run summary.


## Version advisory

Range: v0.1.0 → HEAD
Overall suggested bump: **none**
You selected: `patch`.

_No lib/ symbol changes detected._
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# frozen_string_literal: true

module Foo
# @api public
def self.transform(x)
x * 2
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# frozen_string_literal: true

module Foo
# @api public
def self.transform(x, mode)
mode == :double ? x * 2 : x
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
::notice title=Version advisory::Detected changes suggest 'minor'. You selected 'patch'. See run summary.


## Version advisory

Range: v0.1.0 → HEAD
Overall suggested bump: **minor**
You selected: `patch`.

| Change | Classification | Evidence | Suggested |
|---|---|---|---|
| Signature-changed `Foo::transform` | public | annotation `# @api public` at lib/foo.rb:5; demoted major→minor per pre-1.0 SemVer convention | minor |

_Advisory only. Maintainer selects the bump. See ci#369 for the design brief._
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# frozen_string_literal: true

module Foo
# @api public
def self.public_thing(x)
x + 1
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# frozen_string_literal: true

module Foo
# @api public
def self.public_thing(x)
x + 1
end

# @api public
def self.doomed(x)
x
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
::notice title=Version advisory::Detected changes suggest 'minor'. You selected 'patch'. See run summary.


## Version advisory

Range: v0.1.0 → HEAD
Overall suggested bump: **minor**
You selected: `patch`.

| Change | Classification | Evidence | Suggested |
|---|---|---|---|
| Removed `Foo::doomed` | public | annotation `# @api public` at lib/foo.rb:10; demoted major→minor per pre-1.0 SemVer convention | minor |

_Advisory only. Maintainer selects the bump. See ci#369 for the design brief._
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# frozen_string_literal: true

module Foo
# @api public
def self.public_thing(x)
x + 1
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# frozen_string_literal: true

module Foo
# :nodoc:
def self.hidden_helper(x)
x * 2
end

# @api public
def self.public_thing(x)
x + 1
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
::notice title=Version advisory::Detected changes suggest 'patch'.


## Version advisory

Range: v0.1.0 → HEAD
Overall suggested bump: **patch**
You selected: `patch`.

| Change | Classification | Evidence | Suggested |
|---|---|---|---|
| Removed `Foo::hidden_helper` | internal | `:nodoc:` at lib/foo.rb:5 | patch |

_Advisory only. Maintainer selects the bump. See ci#369 for the design brief._
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# frozen_string_literal: true

module Foo
def self.listed(x)
x
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# frozen_string_literal: true

module Foo
def self.listed(x)
x
end

def self.unlisted(x)
x
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
::notice title=Version advisory::Detected changes suggest 'patch'.


## Version advisory

Range: v0.1.0 → HEAD
Overall suggested bump: **patch**
You selected: `patch`.

| Change | Classification | Evidence | Suggested |
|---|---|---|---|
| Removed `Foo::unlisted` | internal | not listed in public_api.txt | patch |

_Advisory only. Maintainer selects the bump. See ci#369 for the design brief._
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Contract file — listed symbols are public
Foo::listed
Loading
Loading