Skip to content

Latest commit

 

History

History
129 lines (94 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

129 lines (94 loc) · 3.33 KB
Raw

Contributing to Authlogic

Issues

Security Issues

Do not disclose security issues in public. Instead, please email:

Ben Johnson <[email protected]>,
Tieg Zaharia <[email protected]>,
Jared Beck <[email protected]>

We will review security issues promptly.

Non-Security Issues

Please use github issues only for bug reports and feature suggestions.

Usage Questions

Please ask usage questions on Stack Overflow.

Development

Most local development should be done using the oldest supported version of ruby. See required_ruby_version in the gemspec.

Testing

Tests can be run against different versions of Rails:

# Rails 5.2
BUNDLE_GEMFILE=gemfiles/rails_5.2.rb bundle install
BUNDLE_GEMFILE=gemfiles/rails_5.2.rb bundle exec rake

# Rails 6.0
BUNDLE_GEMFILE=gemfiles/rails_6.0.rb bundle install
BUNDLE_GEMFILE=gemfiles/rails_6.0.rb bundle exec rake

# Rails 6.1
BUNDLE_GEMFILE=gemfiles/rails_6.1.rb bundle install
BUNDLE_GEMFILE=gemfiles/rails_6.1.rb bundle exec rake

# Rails 7.0
BUNDLE_GEMFILE=gemfiles/rails_7.0.rb bundle install
BUNDLE_GEMFILE=gemfiles/rails_7.0.rb bundle exec rake

# Rails 7.1
BUNDLE_GEMFILE=gemfiles/rails_7.1.rb bundle install
BUNDLE_GEMFILE=gemfiles/rails_7.1.rb bundle exec rake

To run a single test:

BUNDLE_GEMFILE=gemfiles/rails_6.0.rb \
  bundle exec ruby -I test path/to/test.rb

Bundler can be omitted, and the latest installed version of a gem dependency will be used. This is only suitable for certain unit tests.

ruby –I test path/to/test.rb

Test MySQL

mysql -e 'drop database authlogic; create database authlogic;' && \
  DB=mysql BUNDLE_GEMFILE=gemfiles/rails_5.2.rb bundle exec rake

Test PostgreSQL

psql -c 'create database authlogic;' -U postgres
DB=postgres BUNDLE_GEMFILE=gemfiles/rails_6.0.rb bundle exec rake

Linting

Running rake also runs a linter, rubocop. Contributions must pass both the linter and the tests. The linter can be run on its own.

BUNDLE_GEMFILE=gemfiles/rails_6.0.rb bundle exec rubocop

To run the tests without linting, use rake test.

BUNDLE_GEMFILE=gemfiles/rails_6.0.rb bundle exec rake test

Version Control Branches

We've been trying to follow the rails way, stable branches, but have been inconsistent. We should have one branch for each minor version, named like 4-3-stable. Releases should be done on those branches, not in master. So, the "stable" branches should be the only branches with release tags.

A normal release (no backport)

  1. git checkout 4-3-stable # the latest "stable" branch (see above)
  2. git merge master
  3. Update version number in lib/authlogic/version.rb
  4. In the changelog,
  • Add release date to entry
  • Add a new "Unreleased" section at top
  1. In the readme,
  • Update version number in the docs table at the top
  • For non-patch versions, update the compatibility table
  1. Commit with message like "Release 4.3.0"
  2. git push origin 4-3-stable
  3. CI should pass
  4. gem build authlogic.gemspec
  5. gem push authlogic-4.3.0.gem
  6. git tag -a -m "v4.3.0" "v4.3.0"
  7. git push --tags origin 4-3-stable
  8. update the docs in the master branch, because that's what people look at
  • git checkout master
  • git merge --ff-only 4-3-stable
  • optional: amend commit, adding [ci skip]
  • git push