Contributing¶ ↑
Bug reports and pull requests are welcome on GitLab at gitlab.com/oauth-xx/oauth2 . This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
To submit a patch, please fork the project and create a patch with tests. Once you’re happy with it send a pull request.
We so if you make changes, remember to update it.
You can help!¶ ↑
Take a look at the reek
list which is the file called REEK
and find something to improve.
Simply follow these instructions:
-
Fork the repository
-
Create your feature branch (
git checkout -b my-new-feature
) -
Make some fixes.
-
Commit your 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. They are created and updated with the commands:
NOTE: We run on a fork of Appraisal.
Please upvote the PR for eval_gemfile
support
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¶ ↑
To run all tests
bundle exec rake test
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¶ ↑
Your picture could be here!
Made with contributors-img.
Also see GitLab Contributors: gitlab.com/oauth-xx/oauth2/-/graphs/main
For Maintainers¶ ↑
One-time, Per-maintainer, Setup¶ ↑
IMPORTANT: If you want to sign the build you create, your 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 will be signed. See: RubyGems Security Guide
NOTE: To build without signing the gem you must set SKIP_GEM_SIGNING
to some value in your 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 updateGemfile.lock
-
Run
git commit -am "đź”– Prepare release v<VERSION>"
to commit the changes -
Run
git push
to trigger the final CI pipeline before release, & 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 you will release the latest trunk code -
Set
SOURCE_DATE_EPOCH
sorake build
andrake 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 that you’ll need the
zsh/datetime
module, if runningzsh
. -
In older versions of
bash
you can usedate +%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 thestone_checksums
gem.-
Checksums will be committed automatically by the script but not pushed
-
-
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