README.md in gitlab-license-2.2.0 vs README.md in gitlab-license-2.2.1

- old
+ new

@@ -16,10 +16,21 @@ Or install it yourself as: $ gem install gitlab-license +## Release + +To release a new version of this gem, follow these steps: + +1. Bump the `VERSION` constant in [`lib/gitlab/license/version.rb`](https://dev.gitlab.org/gitlab/gitlab-license/-/blob/master/lib/gitlab/license/version.rb#L3). This is typically merged as part of the feature MR. +1. Create a [new release](https://dev.gitlab.org/gitlab/gitlab-license/-/releases) in the project (e.g. `v2.1.0`). For more details on creating a new release, refer to the [documentation](https://dev.gitlab.org/help/user/project/releases/index.md#create-a-release). +1. [Build the gem](https://guides.rubygems.org/command-reference/#gem-build) to be published: `gem build gitlab-license.gemspec` +1. [Publish the gem](https://guides.rubygems.org/publishing) to Rubygems: `gem push gitlab-license-2.1.0.gem` + - Note you will need to be added as an owner in Rubygems in order to publish. + - Once this is published, the new version of the gem can be installed in other projects like CustomersDot or GitLab via bundler or using `gem install` directly. + ## Usage ```ruby # Generate a key pair. You should do this only once. key_pair = OpenSSL::PKey::RSA.generate(2048) @@ -46,28 +57,28 @@ "Name" => "Douwe Maan", "Company" => "GitLab B.V.", "Email" => "douwe@gitlab.com" } -# The date the license starts. +# The date the license starts. # Required. license.starts_at = Date.new(2015, 4, 24) -# The date the license expires. +# The date the license expires. # Not required, to allow lifetime licenses. license.expires_at = Date.new(2016, 4, 23) # The below dates are hardcoded in the license so that you can play with the # period after which there are "repercussions" to license expiration. -# The date admins will be notified about the license's pending expiration. +# The date admins will be notified about the license's pending expiration. # Not required. license.notify_admins_at = Date.new(2016, 4, 19) # The date regular users will be notified about the license's pending expiration. # Not required. license.notify_users_at = Date.new(2016, 4, 23) -# The date "changes" like code pushes, issue or merge request creation +# The date "changes" like code pushes, issue or merge request creation # or modification and project creation will be blocked. # Not required. license.block_changes_at = Date.new(2016, 5, 7) # Restrictions bundled with this license.