Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/omniauth/omniauth-identity.
This project should be a safe, welcoming space for collaboration, so contributors agree to adhere to
the code of conduct.

To submit a patch, please fork the project, create a patch with tests, and send a pull request.

Remember to .

Help out!

Take a look at the reek list which is the file called REEK and find something to improve.

Follow these instructions:

Fork the repository
Create a feature branch (git checkout -b my-new-feature)
Make some fixes.
Commit changes (git commit -am 'Added some feature')
Push to the branch (git push origin my-new-feature)
Make sure to add tests for it. This is important, so it doesn’t break in a future release.
Create new Pull Request.

Appraisals

From time to time the appraisal gemfiles in gemfiles/ will need to be updated.

NOTE: The eval_gemfile feature comes from a fork of Appraisal.

Please upvote the PR for eval_gemfile support

Create or update them with the commands:

BUNDLE_GEMFILE=Appraisal.root.gemfile bundle
BUNDLE_GEMFILE=Appraisal.root.gemfile bundle exec appraisal update
bundle exec rake rubocop_gradual:autocorrect

When adding an appraisal to CI, check the runner tool cache to see which runner to use.

The Reek List

Take a look at the reek list which is the file called REEK and find something to improve.

To refresh the reek list:

bundle exec reek > REEK

Run Tests

NOTE: To run all tests have the following databases installed, configured, and running.

RethinkDB, an open source, real-time, web database, installed and running, e.g.
```
brew install rethinkdb
rethinkdb
```

MongoDB

brew tap mongodb/brew
brew install mongodb-community@4.4
mongod --config /usr/local/etc/mongod.conf

CouchDB - download the .app, or:
```
brew install couchdb
```
CouchDB 3.x requires a set admin password set before startup.
Add one to your $HOMEBREW_PREFIX/etc/local.ini before starting CouchDB e.g.:
```
[admins]
admin = yourabsolutesecret
```
Also add whatever password you set to your .env.local:
```
export COUCHDB_PASSWORD=yourabsolutesecret
```
Then start the CouchDB service
```
brew services start couchdb
```

Now you can run any of the tests!

To run all tests on all databases (except RethinkDB):

bundle exec rake spec:orm:all

To run all tests that do not require any additional services, i.e. excluding MongoDB, CouchDB, & RethinkDB:

bundle exec rake test

To run a specific DB:

# CouchDB / CouchPotato
bundle exec rspec spec spec_orms --tag 'couchdb'

# ActiveRecord and Sequel, as they both use the in-memory SQLite driver.
bundle exec rspec spec spec_orms --tag 'sqlite3'

# NOTE - mongoid and nobrainer specs can't be isolated with "tag" because it still loads everything,
#        and the two libraries are fundamentally incompatible.

# MongoDB / Mongoid
bundle exec rspec spec_orms/mongoid_spec.rb

# RethinkDB / NoBrainer (Ignored by CI! see spec file for reasons)
bundle exec rspec spec_ignored/nobrainer_spec.rb

Lint It

Run all the default tasks, which includes running the gradually autocorrecting linter, rubocop-gradual.

bundle exec rake

Or just run the linter.

bundle exec rake rubocop_gradual:autocorrect

Contributors

Made with contributors-img.

For Maintainers

One-time, Per-maintainer, Setup

IMPORTANT: To sign a build,
a public key for signing gems will need to be picked up by the line in the
gemspec defining the spec.cert_chain (check the relevant ENV variables there).
All releases to RubyGems.org are signed releases.
See: RubyGems Security Guide

NOTE: To build without signing the gem set SKIP_GEM_SIGNING to any value in the environment.

To release a new version:

Run bin/setup && bin/rake as a “test, coverage, & linting” sanity check
Update the version number in version.rb, and ensure CHANGELOG.md reflects changes
Run bin/setup && bin/rake again as a secondary check, and to update Gemfile.lock
Run git commit -am "🔖 Prepare release v<VERSION>" to commit the changes
Run git push to trigger the final CI pipeline before release, and merge PRs
- NOTE: Remember to check the build.
Run export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME
Run git checkout $GIT_TRUNK_BRANCH_NAME
Run git pull origin $GIT_TRUNK_BRANCH_NAME to ensure latest trunk code
Set SOURCE_DATE_EPOCH so rake build and rake release use same timestamp, and generate same checksums
- Run export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH
- If the echo above has no output, then it didn’t work.
- Note: zsh/datetime module is needed, if running zsh.
- In older versions of bash you can use date +%s instead, i.e. export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH
Run bundle exec rake build
Run bin/gem_checksums (more context 1, 2)
to create SHA-256 and SHA-512 checksums. This functionality is provided by the stone_checksums
gem.
- The script automatically commits but does not push the checksums
Run bundle exec rake release which will create a git tag for the version,
push git commits and tags, and push the .gem file to rubygems.org