gitlab-releases 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6b714bf4ec97c53e2345b9e37ca6ebd80ad25b0ca2b2eca602565e912a0d8304
+  data.tar.gz: 595b3cf4d281e55b5b538a3e3d2c93f1cf93540043388bff53360e2ec730e4ff
+SHA512:
+  metadata.gz: 5a9fa9d47462aac1a1a4ade789bd852ff5e328efedddf20227ce4e7f63cdd5a4977687017c3909797107e0b31ddfa9f0ba7a74dc6495873dd8a97b75c35ec1a0
+  data.tar.gz: 36371646feb42520150c63983a1664c22697e6dcb387cbe3ba4cca6c7d96607c6d470a2269eb8209b1dc37a0e6a839fe981e32dd89a36b278e77c2cfe7eb050b

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: false
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-08-01
+
+- Initial release. Starting with 16.6, GitLab monthly release date will be moved from the 22nd to the 3rd Thursday of each month, this gem automatically calculates the release dates and the associated version for 12 months in advance.
+
+## [0.1.1] - 2023-08-21
+
+- Gem renamed to `releases` to account for new utility methods included (`active_version`,  `current_version`, `next_versions`)
+
+## [0.1.2] - 2023-08-22
+
+- Yanked version
+
+## [0.1.3] - 2023-08-22
+
+- `version_for_date` and `previous_version` methods included.
+
+## [0.2.0] - 2023-08-31
+
+- Gem renamed to `gitlab-releases` to align with GitLab gem naming conventions
+- PRODUCTION_TOKEN renamed to RELEASES_GITLAB_READ_TOKEN

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at mcabrera@gitlab.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gitlab-releases.gemspec
+gemspec
+
+gem 'activesupport', '~> 7.0.0'
+gem 'gitlab', '~> 4.19.0'
+gem 'http', '~> 5.1.0'
+gem 'rake', '~> 13.0'
+gem 'retriable', '~> 3.1.2'
+gem 'version_sorter', '~> 2.3.0'
+
+group :development, :test do
+  gem 'pry', '~> 0.14.0'
+  gem 'rspec', '~> 3.0'
+  gem 'rspec-parameterized', '>= 1.0.0'
+  gem 'rubocop', '~> 1.21'
+  gem 'timecop', '~> 0.9.0'
+  gem 'vcr', '~> 6.2.0'
+  gem 'webmock', '~> 3.18.0'
+end

data/Gemfile.lock

@@ -0,0 +1,158 @@
+PATH
+  remote: .
+  specs:
+    gitlab-releases (0.2.0)
+      activesupport (~> 7.0.0)
+      gitlab (~> 4.19.0)
+      http (~> 5.1.0)
+      retriable (~> 3.1.2)
+      version_sorter (~> 2.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    binding_of_caller (1.0.0)
+      debug_inspector (>= 0.0.1)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    crack (0.4.5)
+      rexml
+    debug_inspector (1.1.0)
+    diff-lcs (1.5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.15.5)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    gitlab (4.19.0)
+      httparty (~> 0.20)
+      terminal-table (>= 1.5.1)
+    hashdiff (1.0.1)
+    http (5.1.1)
+      addressable (~> 2.8)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.4.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    llhttp-ffi (0.4.0)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.19.0)
+    multi_xml (0.6.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    proc_to_ast (0.1.0)
+      coderay
+      parser
+      unparser
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.3)
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    retriable (3.1.2)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-parameterized (1.0.0)
+      rspec-parameterized-core (< 2)
+      rspec-parameterized-table_syntax (< 2)
+    rspec-parameterized-core (1.0.0)
+      parser
+      proc_to_ast
+      rspec (>= 2.13, < 4)
+      unparser
+    rspec-parameterized-table_syntax (1.0.0)
+      binding_of_caller
+      rspec-parameterized-core (< 2)
+    rspec-support (3.12.1)
+    rubocop (1.55.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    timecop (0.9.8)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    unicode-display_width (2.4.2)
+    unparser (0.6.8)
+      diff-lcs (~> 1.3)
+      parser (>= 3.2.0)
+    vcr (6.2.0)
+    version_sorter (2.3.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-darwin-22
+
+DEPENDENCIES
+  activesupport (~> 7.0.0)
+  gitlab (~> 4.19.0)
+  gitlab-releases!
+  http (~> 5.1.0)
+  pry (~> 0.14.0)
+  rake (~> 13.0)
+  retriable (~> 3.1.2)
+  rspec (~> 3.0)
+  rspec-parameterized (>= 1.0.0)
+  rubocop (~> 1.21)
+  timecop (~> 0.9.0)
+  vcr (~> 6.2.0)
+  version_sorter (~> 2.3.0)
+  webmock (~> 3.18.0)
+
+BUNDLED WITH
+   2.3.25

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Mayra Cabrera
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+[![Gem Version](https://badge.fury.io/rb/gitlab-releases.svg)](https://badge.fury.io/rb/gitlab-releases)
+
+# Releases
+
+Library to interact with GitLab releases and versions. The information is fetched from two sources:
+
+1. [versions.gitlab.com](https://version.gitlab.com/)
+1. [`releases.yml`](https://gitlab.com/gitlab-com/www-gitlab-com/-/blob/master/data/releases.yml)
+
+## Installation
+
+Gemfile:
+
+```
+gem 'gitlab-releases', '~> 0.2.0'
+```
+
+Install:
+```
+$ gem install gitlab-releases
+```
+
+## Usage
+
+There are different methods available:
+
+* `upcoming_releases` - Returns the GitLab release date and the associated version for the next 12 months.
+* `active_version`  - Returns the active GitLab version.
+* `current_version` - Returns the current GitLab version.
+* `next_versions` - Returns the next GitLab patch versions (for patch and security releases).
+* `previous_version` - Returns the n-1 GitLab version
+
+To make use of it:
+
+1. Create a personal access token with `read_api` scope.
+1. Store it in an environment variable called `RELEASES_GITLAB_READ_TOKEN`.
+1. Open up an irb session:
+
+```ruby
+> require 'gitlab_releases'
+> releases = GitlabReleases
+> releases.upcoming_releases
+=>
+{"16.2"=>"2023-07-22",
+ "16.3"=>"2023-08-22",
+ "16.4"=>"2023-09-22",
+ "16.5"=>"2023-10-22",
+ "16.6"=>"2023-11-16",
+ "16.7"=>"2023-12-21",
+ "16.8"=>"2024-01-18",
+ "16.9"=>"2024-02-15",
+ "16.10"=>"2024-03-21",
+ "16.11"=>"2024-04-18",
+ "17.0"=>"2024-05-16",
+ "17.1"=>"2024-06-20",
+ "17.2"=>"2024-07-18"}
+
+> releases.active_version
+=> "16.3"
+> releases.current_version
+=> "16.2"
+> releases.next_versions
+=> ["16.2.5", "16.1.5", "16.0.9"]
+> releases.previous_version
+=> 16.2.4
+```
+
+## Contributing
+
+Bug reports and feature requests are welcome on the [Delivery team tracker]. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://gitlab.com/gitlab-org/delivery/gitlab-releases/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Releases project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/gitlab-org/delivery/gitlab-releases/main/CODE_OF_CONDUCT.md).
+
+[Delivery team tracker]: https://gitlab.com/gitlab-com/gl-infra/delivery

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/gitlab_releases/date_calculator.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'active_support/all'
+
+class DateCalculator
+  # Represents the minimum version that uses the new release date
+  RELEASE_VERSION = '16.6'
+
+  # Represents the minimum date that uses the new release date
+  RELEASE_DATE = Date.parse('2023-11-16')
+
+  # @param version [ReleaseVersion]
+  # @param candidate_date [Date] - The month to calculate the release date. It should be
+  # the first day of the month.
+  def initialize(next_version:, candidate_date:)
+    @next_version = next_version
+    @candidate_date = candidate_date
+  end
+
+  def execute
+    result_date = if before_new_release_date?
+                    twenty_second_of_the_month
+                  else
+                    calculate_third_thursday_of_month
+                  end
+
+    result_date.strftime('%Y-%m-%d')
+  end
+
+  private
+
+  attr_reader :next_version, :candidate_date
+
+  def before_new_release_date?
+    next_version.to_f < RELEASE_VERSION.to_f && candidate_date < RELEASE_DATE
+  end
+
+  def twenty_second_of_the_month
+    Date.parse("#{candidate_date.year}-#{candidate_date.month}-22")
+  end
+
+  # If the first day of the month is a Thursday, it fetches the subsequent Two thursdays,
+  # if not searches for the 3rd Thursday of the month.
+  def calculate_third_thursday_of_month
+    iterations = candidate_date.thursday? ? 2 : 3
+    third_thursday = candidate_date
+
+    iterations.times do
+      third_thursday = third_thursday.next_occurring(:thursday)
+    end
+
+    third_thursday
+  end
+end

data/lib/gitlab_releases/release_calculator.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative 'date_calculator'
+require_relative 'version_calculator'
+
+class ReleaseCalculator
+  def initialize(current_version:, release_date:)
+    @current_version = current_version
+    @release_date = release_date
+    @release_dates = {}
+  end
+
+  def execute
+    @release_dates[current_version] = release_date.strftime('%Y-%m-%d')
+    next_version = ReleaseVersion.new(current_version.next_minor)
+
+    period(release_date, release_date + 1.year).each do |candidate_date|
+      @release_dates[next_version] = calculate_release_date(next_version, candidate_date)
+      next_version = calculate_release_version(next_version, candidate_date)
+    end
+
+    @release_dates
+  end
+
+  private
+
+  attr_reader :current_version, :release_date, :release_dates
+
+  def period(start_date, end_date)
+    (start_date..end_date)
+      .select { |date| date.day == 1 }
+      .flatten
+  end
+
+  def calculate_release_date(next_version, candidate_date)
+    DateCalculator.new(
+      next_version: next_version,
+      candidate_date: candidate_date
+    ).execute
+  end
+
+  def calculate_release_version(next_version, candidate_date)
+    VersionCalculator.new(
+      version: next_version,
+      candidate_date: candidate_date
+    ).execute
+  end
+end

data/lib/gitlab_releases/release_version.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+class ReleaseVersion < String
+  VERSION_REGEX = /
+  \A(?<major>\d+)
+  \.(?<minor>\d+)
+  (\.(?<patch>\d+))?
+    (-(?<rc>rc(?<rc_number>\d*)))?
+    (-\h+\.\h+)?
+    (-ee|\.ee\.\d+)?\z
+  /x
+
+  def major
+    @major ||= extract_from_version(:major).to_i
+  end
+
+  def minor
+    @minor ||= extract_from_version(:minor).to_i
+  end
+
+  def patch
+    @patch ||= extract_from_version(:patch).to_i
+  end
+
+  def next_minor
+    "#{major}.#{minor + 1}"
+  end
+
+  def next_major
+    "#{major + 1}.0"
+  end
+
+  def to_minor
+    "#{major}.#{minor}"
+  end
+
+  def previous_minor
+    "#{major}.#{minor - 1}"
+  end
+
+  def previous_patch
+    return unless patch?
+
+    new_patch = self.class.new("#{major}.#{minor}.#{patch - 1}")
+
+    ee? ? new_patch.to_ee : new_patch
+  end
+
+  def next_patch
+    new_patch = self.class.new("#{major}.#{minor}.#{patch + 1}")
+
+    ee? ? new_patch.to_ee : new_patch
+  end
+
+  def ee?
+    end_with?('-ee')
+  end
+
+  def patch?
+    patch.positive?
+  end
+
+  def to_ee
+    return self if ee?
+
+    self.class.new("#{self}-ee")
+  end
+
+  private
+
+  # rubocop:disable Lint/SafeNavigation
+  def extract_from_version(part, fallback: 0)
+    match_data = self.class::VERSION_REGEX.match(self)
+
+    if match_data && match_data.names.include?(part.to_s) && match_data[part]
+      String.new(match_data[part])
+    else
+      fallback
+    end
+  end
+  # rubocop:enable Lint/SafeNavigation
+end

data/lib/gitlab_releases/release_version_client.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'gitlab/request'
+require 'gitlab'
+
+class ReleaseVersionClient < Gitlab::Request
+  base_uri 'https://version.gitlab.com'
+  headers 'Private-Token' => -> { api_token }
+
+  # Get the latest version information
+  #
+  # Returns an Array of Gitlab::ObjectifiedHash objects
+  def self.versions
+    get('/api/v1/versions', query: { per_page: 50 })
+  end
+
+  def self.api_token
+    ENV.fetch('RELEASES_GITLAB_READ_TOKEN') do |name|
+      raise "Must specify `#{name}` environment variable!"
+    end
+  end
+
+  private_class_method :api_token
+end

data/lib/gitlab_releases/release_versions.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require 'version_sorter'
+require 'retriable'
+require 'http'
+require_relative 'release_version_client'
+
+# Wrapper to interact with GitLab release versions. Versions are fetched
+# from two sources:
+#
+# 1. versions.gitlab.com => Used to interact with previous GitLab versions
+# 1. releases.yml => Used to interact with upcoming GitLab releases
+class ReleaseVersions
+  # The base interval for retrying operations that failed, in seconds.
+  RETRY_INTERVAL = 5
+
+  # Releases.yml file.
+  RELEASES_YAML = 'https://gitlab.com/gitlab-com/www-gitlab-com/-/raw/master/data/releases.yml'
+
+  # Returns the list of versions from versions.gitlab.com
+  def self.current_list
+    raw_versions.collect(&:version)
+  end
+
+  # Get the next three patch versions
+  def self.next_versions
+    self.next(latest(current_list, 3))
+  end
+
+  # Given an Array of version numbers, return the next patch versions
+  #
+  # Example:
+  #
+  #   next(['1.0.0', '1.1.0', '1.1.1', '1.2.3'])
+  #   => ['1.0.1', '1.1.1', '1.1.2', '1.2.4']
+  def self.next(versions)
+    versions.map do |version|
+      ReleaseVersion.new(version).next_patch
+    end
+  end
+
+  # Given an Array of version strings, find the `count` latest by minor number
+  #
+  # versions - Array of version strings
+  # count    - Number of versions to return (default: 3)
+  #
+  # Example:
+  #
+  #   latest(['1.0.0', '1.1.0', '1.1.1', '1.2.3'], 3)
+  #   => ['1.2.3', '1.1.1', '1.0.0']
+  def self.latest(versions, count = 3)
+    ::VersionSorter.rsort(versions).uniq do |version|
+      version.split('.').take(2)
+    end.take(count)
+  end
+
+  # Returns the current GitLab minor version
+  def self.current_version
+    ReleaseVersion.new(next_versions.first.to_minor)
+  end
+
+  # Returns the release date of the current version
+  def self.previous_release_date
+    date = raw_versions
+      .find { |version| version.version == "#{current_version}.0" }
+      .created_at
+
+    Date.parse(date)
+  end
+
+  # Returns the active minor GitLab Version
+  def self.active_version
+    version_for_date(DateTime.now)
+  end
+
+  # Returns the scheduled major.minor for the given date
+  def self.version_for_date(date)
+    # Returns the release associated with the date by calling `releases_yaml` and fetching the
+    # release whose date is greater than the given date.
+    #
+    # For example:
+    #
+    # | Version | Date           |
+    # |:--------|:---------------|
+    # | 16.3    | August 22nd    |
+    # | 16.4    | September 22nd |
+    # | 16.5    | October 22nd   |
+    # | 16.6    | November 16th  |
+    # | 16.7    | December 21st  |
+    #
+    # * For August 21st, the release should be 16.3
+    # * For August 22nd, the release should be 16.4
+    # * For August 23rd, the release should be 16.4
+    # * For November 17th, the release should be 16.7
+    return nil if releases_yaml.empty?
+
+    row = releases_yaml.find { |release| release['date'] > date }
+
+    ReleaseVersion.new(row['version'])
+  end
+
+  # Returns the N-1 version supported based on the current_list
+  #
+  # For example:
+  # => current_list
+  # => ["16.3.0",  "16.2.4",  "16.1.4", "16.2.3"]
+  # => previous_version
+  # => ['16.2.4']
+  def self.previous_version
+    ReleaseVersion.new(sort(current_list).reverse[1])
+  end
+
+  def self.sort(versions)
+    ::VersionSorter.sort(versions).uniq
+  end
+
+  def self.raw_versions
+    ReleaseVersionClient.versions
+  end
+
+  def self.releases_yaml
+    @releases_yaml ||=
+      begin
+        data = YAML.safe_load(releases_information) || []
+        data.map { |release| release['date'] = Date.parse(release['date']) }
+        data.sort_by { |release| release['date'] }
+      rescue StandardError
+        []
+      end
+  end
+
+  def self.releases_information
+    Retriable.retriable(base_interval: RETRY_INTERVAL) do
+      HTTP.get(RELEASES_YAML).to_s
+    end
+  end
+
+  private_class_method :raw_versions, :releases_yaml, :releases_information
+end

data/lib/gitlab_releases/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GitlabReleases
+  VERSION = "0.2.0"
+end

data/lib/gitlab_releases/version_calculator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class VersionCalculator
+  MAJOR_RELEASE_MONTH = 5 # represents the month major releases are performed, in this case May
+
+  def initialize(version:, candidate_date:)
+    @version = version
+    @candidate_date = candidate_date
+  end
+
+  def execute
+    if candidate_date.month == (MAJOR_RELEASE_MONTH - 1)
+      next_major
+    else
+      next_minor
+    end
+  end
+
+  private
+
+  attr_reader :version, :candidate_date
+
+  def next_major
+    ReleaseVersion.new(version).next_major
+  end
+
+  def next_minor
+    ReleaseVersion.new(version).next_minor
+  end
+end

data/lib/gitlab_releases.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'gitlab_releases/version'
+require_relative 'gitlab_releases/release_version'
+require_relative 'gitlab_releases/release_versions'
+require_relative 'gitlab_releases/release_calculator'
+
+module GitlabReleases
+  def self.upcoming_releases
+    ReleaseCalculator.new(
+      current_version: current_version,
+      release_date: release_date
+    ).execute
+  end
+
+  def self.current_version
+    ReleaseVersions.current_version
+  end
+
+  def self.active_version
+    ReleaseVersions.active_version
+  end
+
+  def self.version_for_date(date)
+    ReleaseVersions.version_for_date(date)
+  end
+
+  def self.next_versions
+    ReleaseVersions.next_versions
+  end
+
+  def self.previous_version
+    ReleaseVersions.previous_version
+  end
+
+  def self.release_date
+    ReleaseVersions.previous_release_date
+  end
+
+  private_class_method :release_date
+end

data/sig/release_dates.rbs

@@ -0,0 +1,4 @@
+module ReleaseDates
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: gitlab-releases
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Mayra Cabrera
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: gitlab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.19.0
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: retriable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+- !ruby/object:Gem::Dependency
+  name: version_sorter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+description:
+email:
+- mcabrera@gitlab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/gitlab_releases.rb
+- lib/gitlab_releases/date_calculator.rb
+- lib/gitlab_releases/release_calculator.rb
+- lib/gitlab_releases/release_version.rb
+- lib/gitlab_releases/release_version_client.rb
+- lib/gitlab_releases/release_versions.rb
+- lib/gitlab_releases/version.rb
+- lib/gitlab_releases/version_calculator.rb
+- sig/release_dates.rbs
+homepage: https://gitlab.com/gitlab-org/delivery/releases
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/gitlab-org/delivery/releases
+  source_code_uri: https://gitlab.com/gitlab-org/delivery/gitlab-releases
+  changelog_uri: https://gitlab.com/gitlab-org/delivery/gitlab-releases/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.13
+signing_key:
+specification_version: 4
+summary: Utilities for GitLab releases and versions
+test_files: []