Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace TravisCI to Github Actions #34

Merged
merged 7 commits into from
Mar 1, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix CI, update README.md
  • Loading branch information
blacksam07 committed Feb 13, 2024
commit ace189d7929a18dfa35da03910da20df0afe16d9
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ jobs:
timeout-minutes: 1
- name: Test & publish code coverage
uses: paambaati/[email protected]
if: matrix.coverage
env:
CC_TEST_REPORTER_ID: ${{ env.CC_TEST_REPORTER_ID }}
with:
coverageCommand: bundle exec rspec
coverageLocations: ${{ github.workspace }}/coverage/coverage.json:simplecov
debug: true
if: matrix.coverage
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AppleAuth

[![CI](https://api.travis-ci.com/rootstrap/apple_auth.svg?branch=master)](https://travis-ci.com/github/rootstrap/apple_auth)
[![Gem Version](https://badge.fury.io/rb/apple_auth.svg)](https://badge.fury.io/rb/apple_auth)
[![Maintainability](https://api.codeclimate.com/v1/badges/78453501221a76e3806e/maintainability)](https://codeclimate.com/github/rootstrap/apple_sign_in/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/78453501221a76e3806e/test_coverage)](https://codeclimate.com/github/rootstrap/apple_sign_in/test_coverage)

Expand All @@ -20,13 +20,14 @@ Or install it yourself:

$ gem install apple_auth

------------------
---

After installing the gem, you need to run this generator.

$ rails g apple_auth:config

This will generate a new initializer: `apple_auth.rb` with the following default configuration:

```ruby
AppleAuth.configure do |config|
# config.apple_client_id = <Your client_id in your Apple Developer account>
Expand All @@ -36,9 +37,10 @@ AppleAuth.configure do |config|
# config.redirect_uri = <Your app redirect url>
end
```

Set your different credentials in the file by uncommenting the lines and adding your keys.

------------------
---

## Usage

Expand Down Expand Up @@ -143,6 +145,7 @@ An example `$ rails g apple_auth:apple_auth_controller api/v1/`
This will generate a new controller: `controllers/api/v1/apple_auth_controller.rb`.

You should configure the route, you can wrap it in the devise_scope block like:

```
devise_scope :user do
resource :user, only: %i[update show] do
Expand All @@ -167,7 +170,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To

Bug reports and pull requests are welcome on GitHub at https://github.com/rootstrap/apple_auth/issues. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/rootstrap/apple_auth/blob/master/CODE_OF_CONDUCT.md).


## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
Expand Down
Loading