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.

Sign up for GitHub

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

Update README.md with Release information #21

Merged
merged 1 commit into from
Jan 20, 2025
Merged

Update README.md with Release information #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,18 @@ docker-compose run dev bundle exec rspec

All contributions are welcome, feel free to create a Pull request.

### Testing the gem locally in a Rails application

In case you want to use the gem in our of our application from your local code, you can do the following:

* Add a new volume in the Rails application's docker-compose with `~/${PATH_TO_THE_GEM}:/app/vendor/gems/factiva-api-client`
* Update the Gemfile to use the gem from `path:` with line `gem "factiva-api-client", path: '/app/vendor/gems/factiva-api-client'`

### Releasing a new version

A new version is released when the code is merged to `master` branch if you have conventional commits:

* Use fix: for patches.
* Use feat: for minor releases.
* Use feat!: or BREAKING CHANGE: for major releases.
* Other types (chore:, docs:, test:) will not trigger a release.
Loading