Ruby GitHub Packages

RubyGems is the default server when publishing a public gem but, sometimes, you can't open source your work. An alternative solution is to use GitHub Packages for publishing private gems so your internal programs, applications, and/or services can have the same convenience as what you'd find when using RubyGems. In this talk, you'll learn how to use Gemsmith to publish your gem to your own GitHub Packages repository while using GitHub Actions to automate the entire process.

Transcript

1. Ruby GitHub Packages Presented by Brooke Kuhlmann
2. Overview
3. • Gemsmith Overview
4. • Gemsmith • Server Choices Overview
5. • Gemsmith • Server Choices • GitHub Packages + Actions Overview
6. • Gemsmith • Server Choices • GitHub Packages + Actions • Source Code Overview
7. • Gemsmith • Server Choices • GitHub Packages + Actions • Source Code • Debugging Techniques Overview
8. Servers
9. RubyGems (public) Servers
10. RubyGems GitHub Packages (public) (private) Servers
11. RubyGems GitHub Packages (public) (private) Gemfury (private) Servers
12. https://www.alchemists.io/projects/gemsmith
13. Gemsmith https://www.alchemists.io/projects/gemsmith
14. https://docs.github.com/en/packages
15. GitHub Packages https://docs.github.com/en/packages
16. https://docs.github.com/en/packages
17. https://docs.github.com/en/packages
18. https://docs.github.com/en/packages
19. https://docs.github.com/en/packages
20. https://docs.github.com/en/packages
21. https://docs.github.com/en/packages
22. https://docs.github.com/en/packages
23. https://docs.github.com/en/packages
24. https://docs.github.com/en/actions
25. GitHub Actions https://docs.github.com/en/actions
26. https://docs.github.com/en/actions
27. New Version 🚀 https://docs.github.com/en/actions
28. New Version 🚀 https://docs.github.com/en/actions
29. New Version 🚀 1 https://docs.github.com/en/actions
30. New Version 🚀 1. Builds releases notes. 1 https://docs.github.com/en/actions
31. New Version 🚀 1. Builds releases notes. 2. Tags version. 1 https://docs.github.com/en/actions
32. New Version 🚀 1. Builds releases notes. 2. Tags version. 3. Publishes gem. 1 https://docs.github.com/en/actions
33. New Version 🚀 2 https://docs.github.com/en/actions
34. https://docs.github.com/en/actions
35. Existing Version ℹ https://docs.github.com/en/actions
36. Existing Version ℹ Benign 🎉 https://docs.github.com/en/actions
37. https://docs.github.com/en/actions
38. No Versions 🚫 https://docs.github.com/en/actions
39. No Versions 🚫 https://docs.github.com/en/actions
40. No Versions 🚫 💡 Only fi rst version is manual. https://docs.github.com/en/actions
42. Source Code
43. https://www.alchemists.io/projects/gemsmith
44. Gem Credentials https://www.alchemists.io/projects/gemsmith
45. https://www.alchemists.io/projects/gemsmith
46. https://www.alchemists.io/projects/gemsmith # $HOME/.gem/credentials :rubygems_api_key: <redacted> https://rubygems.pkg.github.com/alchemists: Bearer <redacted>
47. https://www.alchemists.io/projects/gemsmith # $HOME/.gem/credentials :rubygems_api_key: <redacted> https://rubygems.pkg.github.com/alchemists: Bearer <redacted>
48. https://www.alchemists.io/projects/gemsmith # $HOME/.gem/credentials :rubygems_api_key: <redacted> https://rubygems.pkg.github.com/alchemists: Bearer <redacted>
49. https://www.alchemists.io/projects/gemsmith # $HOME/.gem/credentials :rubygems_api_key: <redacted> https://rubygems.pkg.github.com/alchemists: Bearer <redacted>
50. https://www.alchemists.io/projects/gemsmith # $HOME/.gem/credentials :rubygems_api_key: <redacted> https://rubygems.pkg.github.com/alchemists: Bearer <redacted> (also your gem speci fi cation value)
51. https://www.alchemists.io/projects/gemsmith # $HOME/.gem/credentials :rubygems_api_key: <redacted> https://rubygems.pkg.github.com/alchemists: Bearer <redacted> Personal Access Token
52. https://www.alchemists.io/projects/gemsmith
53. Gem Speci fi cation https://www.alchemists.io/projects/gemsmith
54. https://www.alchemists.io/projects/gemsmith
55. Gem::Specification.new do |spec| spec.name = "demo" spec.version = "0.0.0" spec.authors = ["Alchemists Engineering"] spec.email = ["engineering@alchemists.io"] spec.homepage = "https://www.alchemists.io/projects/demo" spec.summary = "This is a demo gem." spec.license = "Nonstandard" spec.metadata = { "allowed_push_host" => "https://rubygems.pkg.github.com/alchemists", "bug_tracker_uri" => "https://github.com/alchemists/demo/issues", "changelog_uri" => "https://www.alchemists.io/projects/demo/versions", "documentation_uri" => "https://www.alchemists.io/projects/demo", "label" => "Demo", "source_code_uri" => "https://github.com/alchemists/demo" } spec.required_ruby_version = "~> 3.1" spec.add_dependency "auto_injector", "~> 0.4" spec.add_dependency "dry-container", "~> 0.9" spec.add_dependency "refinements", "~> 9.2" spec.add_dependency "runcom", "~> 8.2" spec.add_dependency "spek", "~> 0.2" spec.add_dependency "zeitwerk", "~> 2.5" spec.bindir = "exe" spec.executables << "demo" spec.extra_rdoc_files = Dir["README*", "LICENSE*"] spec.files = Dir["*.gemspec", "lib/**/*"] end https://www.alchemists.io/projects/gemsmith
56. Gem::Specification.new do |spec| spec.name = "demo" spec.version = "0.0.0" spec.authors = ["Alchemists Engineering"] spec.email = ["engineering@alchemists.io"] spec.homepage = "https://www.alchemists.io/projects/demo" spec.summary = "This is a demo gem." spec.license = "Nonstandard" spec.metadata = { "allowed_push_host" => "https://rubygems.pkg.github.com/alchemists", "bug_tracker_uri" => "https://github.com/alchemists/demo/issues", "changelog_uri" => "https://www.alchemists.io/projects/demo/versions", "documentation_uri" => "https://www.alchemists.io/projects/demo", "label" => "Demo", "source_code_uri" => "https://github.com/alchemists/demo" } spec.required_ruby_version = "~> 3.1" spec.add_dependency "auto_injector", "~> 0.4" spec.add_dependency "dry-container", "~> 0.9" spec.add_dependency "refinements", "~> 9.2" spec.add_dependency "runcom", "~> 8.2" spec.add_dependency "spek", "~> 0.2" spec.add_dependency "zeitwerk", "~> 2.5" spec.bindir = "exe" spec.executables << "demo" spec.extra_rdoc_files = Dir["README*", "LICENSE*"] spec.files = Dir["*.gemspec", "lib/**/*"] end https://www.alchemists.io/projects/gemsmith ❗Only update when ready to release
57. Gem::Specification.new do |spec| spec.name = "demo" spec.version = "0.0.0" spec.authors = ["Alchemists Engineering"] spec.email = ["engineering@alchemists.io"] spec.homepage = "https://www.alchemists.io/projects/demo" spec.summary = "This is a demo gem." spec.license = "Nonstandard" spec.metadata = { "allowed_push_host" => "https://rubygems.pkg.github.com/alchemists", "bug_tracker_uri" => "https://github.com/alchemists/demo/issues", "changelog_uri" => "https://www.alchemists.io/projects/demo/versions", "documentation_uri" => "https://www.alchemists.io/projects/demo", "label" => "Demo", "source_code_uri" => "https://github.com/alchemists/demo" } spec.required_ruby_version = "~> 3.1" spec.add_dependency "auto_injector", "~> 0.4" spec.add_dependency "dry-container", "~> 0.9" spec.add_dependency "refinements", "~> 9.2" spec.add_dependency "runcom", "~> 8.2" spec.add_dependency "spek", "~> 0.2" spec.add_dependency "zeitwerk", "~> 2.5" spec.bindir = "exe" spec.executables << "demo" spec.extra_rdoc_files = Dir["README*", "LICENSE*"] spec.files = Dir["*.gemspec", "lib/**/*"] end (also your gem credentials key) https://www.alchemists.io/projects/gemsmith
61. Gem::Specification.new do |spec| spec.metadata = { "allowed_push_host" => "https://rubygems.pkg.github.com/alchemists" } end https://rubygems.pkg.github.com/alchemists: Bearer <redacted> Gem Speci fi cation Gem Credentials
62. https://docs.github.com/en/actions
63. GitHub Actions https://docs.github.com/en/actions
64. https://docs.github.com/en/actions
65. name: Gemsmith on: push: branches: main jobs: build: runs-on: ubuntu-latest container: image: ruby:latest permissions: contents: write packages: write steps: - name: Checkout uses: actions/checkout@v3 with: fetch-depth: '0' ref: ${{github.head_ref}} - name: Setup run: | git config user.email "engineering@alchemists.io" git config user.name "Alchemists Publisher" mkdir -p $HOME/.gem printf "%s\n" "https://rubygems.pkg.github.com/alchemists: Bearer ${{secrets.GITHUB_TOKEN}}" > $HOME/.gem/credentials chmod 0600 $HOME/.gem/credentials - name: Install run: gem install gemsmith - name: Publish run: | if git describe --tags --abbrev=0 > /dev/null 2>&1; then gemsmith --publish else printf "%s\n" "First gem version must be manually created. Skipping." https://docs.github.com/en/actions
66. name: Gemsmith on: push: branches: main jobs: build: runs-on: ubuntu-latest container: image: ruby:latest permissions: contents: write packages: write steps: - name: Checkout uses: actions/checkout@v3 with: fetch-depth: '0' ref: ${{github.head_ref}} - name: Setup run: | git config user.email "engineering@alchemists.io" git config user.name "Alchemists Publisher" mkdir -p $HOME/.gem printf "%s\n" "https://rubygems.pkg.github.com/alchemists: Bearer ${{secrets.GITHUB_TOKEN}}" > $HOME/.gem/credentials chmod 0600 $HOME/.gem/credentials - name: Install run: gem install gemsmith - name: Publish run: | if git describe --tags --abbrev=0 > /dev/null 2>&1; then gemsmith --publish else printf "%s\n" "First gem version must be manually created. Skipping." https://docs.github.com/en/actions
67. name: Gemsmith on: push: branches: main jobs: build: runs-on: ubuntu-latest container: image: ruby:latest permissions: contents: write packages: write steps: - name: Checkout uses: actions/checkout@v3 with: fetch-depth: '0' ref: ${{github.head_ref}} - name: Setup run: | git config user.email "engineering@alchemists.io" git config user.name "Alchemists Publisher" mkdir -p $HOME/.gem printf "%s\n" "https://rubygems.pkg.github.com/alchemists: Bearer ${{secrets.GITHUB_TOKEN}}" > $HOME/.gem/credentials chmod 0600 $HOME/.gem/credentials - name: Install run: gem install gemsmith - name: Publish run: | if git describe --tags --abbrev=0 > /dev/null 2>&1; then gemsmith --publish else printf "%s\n" "First gem version must be manually created. Skipping." https://docs.github.com/en/actions
68. name: Gemsmith on: push: branches: main jobs: build: runs-on: ubuntu-latest container: image: ruby:latest permissions: contents: write packages: write steps: - name: Checkout uses: actions/checkout@v3 with: fetch-depth: '0' ref: ${{github.head_ref}} - name: Setup run: | git config user.email "engineering@alchemists.io" git config user.name "Alchemists Publisher" mkdir -p $HOME/.gem printf "%s\n" "https://rubygems.pkg.github.com/alchemists: Bearer ${{secrets.GITHUB_TOKEN}}" > $HOME/.gem/credentials chmod 0600 $HOME/.gem/credentials - name: Install run: gem install gemsmith - name: Publish run: | if git describe --tags --abbrev=0 > /dev/null 2>&1; then gemsmith --publish else printf "%s\n" "First gem version must be manually created. Skipping." https://docs.github.com/en/actions
69. name: Gemsmith on: push: branches: main jobs: build: runs-on: ubuntu-latest container: image: ruby:latest permissions: contents: write packages: write steps: - name: Checkout uses: actions/checkout@v3 with: fetch-depth: '0' ref: ${{github.head_ref}} - name: Setup run: | git config user.email "engineering@alchemists.io" git config user.name "Alchemists Publisher" mkdir -p $HOME/.gem printf "%s\n" "https://rubygems.pkg.github.com/alchemists: Bearer ${{secrets.GITHUB_TOKEN}}" > $HOME/.gem/credentials chmod 0600 $HOME/.gem/credentials - name: Install run: gem install gemsmith - name: Publish run: | if git describe --tags --abbrev=0 > /dev/null 2>&1; then gemsmith --publish else printf "%s\n" "First gem version must be manually created. Skipping." Git Tags https://docs.github.com/en/actions
70. name: Gemsmith on: push: branches: main jobs: build: runs-on: ubuntu-latest container: image: ruby:latest permissions: contents: write packages: write steps: - name: Checkout uses: actions/checkout@v3 with: fetch-depth: '0' ref: ${{github.head_ref}} - name: Setup run: | git config user.email "engineering@alchemists.io" git config user.name "Alchemists Publisher" mkdir -p $HOME/.gem printf "%s\n" "https://rubygems.pkg.github.com/alchemists: Bearer ${{secrets.GITHUB_TOKEN}}" > $HOME/.gem/credentials chmod 0600 $HOME/.gem/credentials - name: Install run: gem install gemsmith - name: Publish run: | if git describe --tags --abbrev=0 > /dev/null 2>&1; then gemsmith --publish else printf "%s\n" "First gem version must be manually created. Skipping." Packages https://docs.github.com/en/actions
71. name: Gemsmith on: push: branches: main jobs: build: runs-on: ubuntu-latest container: image: ruby:latest permissions: contents: write packages: write steps: - name: Checkout uses: actions/checkout@v3 with: fetch-depth: '0' ref: ${{github.head_ref}} - name: Setup run: | git config user.email "engineering@alchemists.io" git config user.name "Alchemists Publisher" mkdir -p $HOME/.gem printf "%s\n" "https://rubygems.pkg.github.com/alchemists: Bearer ${{secrets.GITHUB_TOKEN}}" > $HOME/.gem/credentials chmod 0600 $HOME/.gem/credentials - name: Install run: gem install gemsmith - name: Publish run: | if git describe --tags --abbrev=0 > /dev/null 2>&1; then gemsmith --publish else printf "%s\n" "First gem version must be manually created. Skipping." https://docs.github.com/en/actions
72. name: Gemsmith on: push: branches: main jobs: build: runs-on: ubuntu-latest container: image: ruby:latest permissions: contents: write packages: write steps: - name: Checkout uses: actions/checkout@v3 with: fetch-depth: '0' ref: ${{github.head_ref}} - name: Setup run: | git config user.email "engineering@alchemists.io" git config user.name "Alchemists Publisher" mkdir -p $HOME/.gem printf "%s\n" "https://rubygems.pkg.github.com/alchemists: Bearer ${{secrets.GITHUB_TOKEN}}" > $HOME/.gem/credentials chmod 0600 $HOME/.gem/credentials - name: Install run: gem install gemsmith - name: Publish run: | if git describe --tags --abbrev=0 > /dev/null 2>&1; then gemsmith --publish else printf "%s\n" "First gem version must be manually created. Skipping." https://docs.github.com/en/actions
73. name: Gemsmith on: push: branches: main jobs: build: runs-on: ubuntu-latest container: image: ruby:latest permissions: contents: write packages: write steps: - name: Checkout uses: actions/checkout@v3 with: fetch-depth: '0' ref: ${{github.head_ref}} - name: Setup run: | git config user.email "engineering@alchemists.io" git config user.name "Alchemists Publisher" mkdir -p $HOME/.gem printf "%s\n" "https://rubygems.pkg.github.com/alchemists: Bearer ${{secrets.GITHUB_TOKEN}}" > $HOME/.gem/credentials chmod 0600 $HOME/.gem/credentials - name: Install run: gem install gemsmith - name: Publish run: | if git describe --tags --abbrev=0 > /dev/null 2>&1; then gemsmith --publish else printf "%s\n" "First gem version must be manually created. Skipping." https://docs.github.com/en/actions
74. name: Gemsmith on: push: branches: main jobs: build: runs-on: ubuntu-latest container: image: ruby:latest permissions: contents: write packages: write steps: - name: Checkout uses: actions/checkout@v3 with: fetch-depth: '0' ref: ${{github.head_ref}} - name: Setup run: | git config user.email "engineering@alchemists.io" git config user.name "Alchemists Publisher" mkdir -p $HOME/.gem printf "%s\n" "https://rubygems.pkg.github.com/alchemists: Bearer ${{secrets.GITHUB_TOKEN}}" > $HOME/.gem/credentials chmod 0600 $HOME/.gem/credentials - name: Install run: gem install gemsmith - name: Publish run: | if git describe --tags --abbrev=0 > /dev/null 2>&1; then gemsmith --publish else printf "%s\n" "First gem version must be manually created. Skipping." https://docs.github.com/en/actions
75. name: Gemsmith on: push: branches: main jobs: build: runs-on: ubuntu-latest container: image: ruby:latest permissions: contents: write packages: write steps: - name: Checkout uses: actions/checkout@v3 with: fetch-depth: '0' ref: ${{github.head_ref}} - name: Setup run: | git config user.email "engineering@alchemists.io" git config user.name "Alchemists Publisher" mkdir -p $HOME/.gem printf "%s\n" "https://rubygems.pkg.github.com/alchemists: Bearer ${{secrets.GITHUB_TOKEN}}" > $HOME/.gem/credentials chmod 0600 $HOME/.gem/credentials - name: Install run: gem install gemsmith - name: Publish run: | if git describe --tags --abbrev=0 > /dev/null 2>&1; then gemsmith --publish else printf "%s\n" "First gem version must be manually created. Skipping." https://docs.github.com/en/actions
76. name: Gemsmith on: push: branches: main jobs: build: runs-on: ubuntu-latest container: image: ruby:latest permissions: contents: write packages: write steps: - name: Checkout uses: actions/checkout@v3 with: fetch-depth: '0' ref: ${{github.head_ref}} - name: Setup run: | git config user.email "engineering@alchemists.io" git config user.name "Alchemists Publisher" mkdir -p $HOME/.gem printf "%s\n" "https://rubygems.pkg.github.com/alchemists: Bearer ${{secrets.GITHUB_TOKEN}}" > $HOME/.gem/credentials chmod 0600 $HOME/.gem/credentials - name: Install run: gem install gemsmith - name: Publish run: | if git describe --tags --abbrev=0 > /dev/null 2>&1; then gemsmith --publish else printf "%s\n" "First gem version must be manually created. Skipping." https://docs.github.com/en/actions
77. name: Gemsmith on: push: branches: main jobs: build: runs-on: ubuntu-latest container: image: ruby:latest permissions: contents: write packages: write steps: - name: Checkout uses: actions/checkout@v3 with: fetch-depth: '0' ref: ${{github.head_ref}} - name: Setup run: | git config user.email "engineering@alchemists.io" git config user.name "Alchemists Publisher" mkdir -p $HOME/.gem printf "%s\n" "https://rubygems.pkg.github.com/alchemists: Bearer ${{secrets.GITHUB_TOKEN}}" > $HOME/.gem/credentials chmod 0600 $HOME/.gem/credentials - name: Install run: gem install gemsmith - name: Publish run: | if git describe --tags --abbrev=0 > /dev/null 2>&1; then gemsmith --publish else printf "%s\n" "First gem version must be manually created. Skipping." https://docs.github.com/en/actions
78. name: Gemsmith on: push: branches: main jobs: build: runs-on: ubuntu-latest container: image: ruby:latest permissions: contents: write packages: write steps: - name: Checkout uses: actions/checkout@v3 with: fetch-depth: '0' ref: ${{github.head_ref}} - name: Setup run: | git config user.email "engineering@alchemists.io" git config user.name "Alchemists Publisher" mkdir -p $HOME/.gem printf "%s\n" "https://rubygems.pkg.github.com/alchemists: Bearer ${{secrets.GITHUB_TOKEN}}" > $HOME/.gem/credentials chmod 0600 $HOME/.gem/credentials - name: Install run: gem install gemsmith - name: Publish run: | if git describe --tags --abbrev=0 > /dev/null 2>&1; then gemsmith --publish else printf "%s\n" "First gem version must be manually created. Skipping." https://docs.github.com/en/actions
79. name: Gemsmith on: push: branches: main jobs: build: runs-on: ubuntu-latest container: image: ruby:latest permissions: contents: write packages: write steps: - name: Checkout uses: actions/checkout@v3 with: fetch-depth: '0' ref: ${{github.head_ref}} - name: Setup run: | git config user.email "engineering@alchemists.io" git config user.name "Alchemists Publisher" mkdir -p $HOME/.gem printf "%s\n" "https://rubygems.pkg.github.com/alchemists: Bearer ${{secrets.GITHUB_TOKEN}}" > $HOME/.gem/credentials chmod 0600 $HOME/.gem/credentials - name: Install run: gem install gemsmith - name: Publish run: | if git describe --tags --abbrev=0 > /dev/null 2>&1; then gemsmith --publish else printf "%s\n" "First gem version must be manually created. Skipping." 🎉 https://docs.github.com/en/actions
80. https://docs.github.com/en/actions
81. https://docs.github.com/en/actions
82. Debugging 🐞 https://docs.github.com/en/actions
83. Debugging 🐞 https://docs.github.com/en/actions 💩 💩 💩
84. https://docs.github.com/en/actions Additional Steps
85. steps: - name: Environment uses: printenv | sort https://docs.github.com/en/actions Additional Steps
86. steps: - name: Environment uses: printenv | sort https://docs.github.com/en/actions steps: - name: Debug uses: <your Bash script> Additional Steps
87. Act https://github.com/nektos/act
88. Thanks https://www.alchemists.io
89. Thanks 🙇 https://www.alchemists.io