Merge pull request #5 from github/publish-to-rubygems

Publish to rubygems

Author: GrantBirki

.github/workflows/release.yml

@@ -51,3 +51,11 @@ jobs:
           artifacts: "${{ env.GEM_NAME }}-${{ env.GEM_VERSION }}.gem"
           tag: "v${{ env.GEM_VERSION }}"
           generateReleaseNotes: true
+
+      - name: publish to RubyGems
+        run: |
+          mkdir -p ~/.gem
+          echo -e "---\n:rubygems_api_key: ${{ secrets.RUBYGEMS_API_KEY }}" > ~/.gem/credentials
+          chmod 0600 ~/.gem/credentials
+          gem push ${{ env.GEM_NAME }}-${{ env.GEM_VERSION }}.gem
+          rm ~/.gem/credentials

README.md

@@ -10,18 +10,14 @@ A redacting Ruby logger to prevent the leaking of secrets via logs
 
 ## Installation 💎
 
-You can download this Gem from [GitHub Packages](https://github.com/github/redacting-logger/pkgs/rubygems/redacting-logger)
+You can download this Gem from [GitHub Packages](https://github.com/github/redacting-logger/pkgs/rubygems/redacting-logger) or [RubyGems](https://rubygems.org/gems/redacting-logger)
 
 Via a Gemfile:
 
 ```ruby
-# frozen_string_literal: true
-
 source "https://rubygems.org"
 
-source "https://rubygems.pkg.github.com/github" do
-  gem "redacting-logger", "~> X.X.X" # Replace X.X.X with the latest version
-end
+gem "redacting-logger", "~> X.X.X" # Replace X.X.X with the latest version
 ```
 
 ## Usage 💻

redacting-logger.gemspec

@@ -5,8 +5,8 @@ require_relative "lib/version"
 Gem::Specification.new do |spec|
   spec.name          = "redacting-logger"
   spec.version       = RedactingLogger::Version::VERSION
-  spec.authors       = ["Grant Birkinbine"]
-  spec.email         = "grant.birkinbine@gmail.com"
+  spec.authors       = ["GitHub", "GitHub Security"]
+  spec.email         = "opensource@github.com"
   spec.license       = "MIT"
 
   spec.summary       = "A redacting Ruby logger to prevent the leaking of secrets via logs"