Skip to content

Commit

Permalink
Update documentation (#341)
Browse files Browse the repository at this point in the history
**This PR:**
- Adds release signing information to `README.md`
- Updates instructions in `RELEASING.md`
- Updates gemspec:
  - Adds new authors
  - Fixes warnings
  - ...and more
  • Loading branch information
louis-antonopoulos authored Aug 26, 2024
1 parent 1c5c8ba commit 1c40eb7
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 20 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,11 @@ Or install it yourself as:
For instructions on how to integrate Yuri-ita with your Rails application,
[view the Getting Started documentation](docs/getting_started.md).

## Releases

Releases are signed by [email protected].
The fingerprint is `7B3B 5C4E C777 3530 7E65  EF2B D728 8DAC CCC8 0A03`.

## Contributing

See the [CONTRIBUTING] document. Thank you, [contributors]!
Expand Down
23 changes: 14 additions & 9 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,28 @@
# Releasing

1. Update version file accordingly.
## Prepare
1. Update the version number in `lib/yuriita/version.rb`.
1. Update `NEWS.md` to reflect the changes since last release.
1. Commit changes.
There shouldn't be code changes,
and thus CI doesn't need to run,
you can then add "[ci skip]" to the commit message.
1. Tag the release: `git tag -s vVERSION`
- We recommend the [_quick guide on how to sign a release_] from git ready.
1. Push changes: `git push --tags`
1. Open and merge a PR with the changes.

## Tag
1. Tag and sign the release: `git tag -s vVERSION`
[notes on signing]
1. Verify the signed tag: `git tag -v vVERSION`
1. Push changes: `git push --tags`

## Publish
1. Build and publish:
```bash
gem build yuri-ita.gemspec
gem push yuri-ita-*.gem
```

## Announce
1. Add a new GitHub release using the recent `NEWS.md` as the content. Sample
URL: https://github.com/thoughtbot/yuri-ita/releases/new?tag=vVERSION
1. Announce the new release,
making sure to say "thank you" to the contributors
who helped shape this version!

[_quick guide on how to sign a release_]: http://gitready.com/advanced/2014/11/02/gpg-sign-releases.html
[notes on signing]: http://gitready.com/advanced/2014/11/02/gpg-sign-releases.html
23 changes: 12 additions & 11 deletions yuri-ita.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -5,32 +5,33 @@ require "yuriita/version"
Gem::Specification.new do |spec|
spec.name = "yuri-ita"
spec.version = Yuriita::VERSION
spec.authors = ["Eebs Kobeissi"]
spec.email = ["ebrahim.kobeissi@gmail.com"]
spec.authors = ["Louis Antonopoulos", "Sally Hall", "Eebs Kobeissi"]
spec.email = ["louis@thoughtbot.com"]

spec.summary = %q{Filter and search using an expressive, user defined, query language}
spec.homepage = "https://github.com/eebs/yuri-ita"
spec.homepage = "https://github.com/thoughtbot/yuri-ita"

spec.metadata["homepage_uri"] = spec.homepage
spec.metadata["source_code_uri"] = "https://github.com/eebs/yuri-ita"
spec.metadata["changelog_uri"] = "https://github.com/eebs/yuri-ita/CHANGELOG.md"
spec.metadata["changelog_uri"] = "https://github.com/thoughtbot/yuri-ita/blob/main/NEWS.md"

# Specify which files should be added to the gem when it is released.
spec.files = Dir["{lib}/**/*", "LICENSE"]
spec.license = "LicenseRef-LICENSE"

spec.bindir = "exe"
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
spec.require_paths = ["lib"]
spec.required_ruby_version = "~> 3.1"

spec.add_dependency "rltk"
spec.add_dependency "activesupport", ">= 4.2"
spec.add_dependency "activerecord", ">= 4.2"
spec.add_dependency "activemodel", ">= 4.2"
spec.add_dependency "zeitwerk"
spec.add_dependency "rltk", "~> 3.0"
spec.add_dependency "activesupport", "~> 7.0"
spec.add_dependency "activerecord", "~> 7.0"
spec.add_dependency "activemodel", "~> 7.0"
spec.add_dependency "zeitwerk", "~> 2.6"

spec.add_development_dependency "bundler", "~> 2.3"
spec.add_development_dependency "rake", "~> 13.0"
spec.add_development_dependency "rspec", "~> 3.0"
spec.add_development_dependency "rspec_junit_formatter", "~> 0.4"
spec.add_development_dependency "pry-rails"
spec.add_development_dependency "pry-rails", "~> 0.3.7"
end

0 comments on commit 1c40eb7

Please sign in to comment.