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

Update README with local usage #50

Closed
wants to merge 7 commits into from

Conversation

mikitsik
Copy link

@mikitsik mikitsik commented Apr 8, 2024

Closes #36

README.md Outdated
@@ -59,6 +59,30 @@ The gem offers the following rake tasks that can be manually run according to yo
- `rails db:rollback_branches` - run it to manually rolls back phantom migrations.
- `rails db:phantom_migrations` - displays a list of phantom migrations.

### Local usage

If you're enough of a geek to want to develop with your beloved gems alongside the general Gemfile but separate from it, you could leverage this trick:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this be rephrased so that it doesn't include possibly offensive words, such as geek?

For reference

README.md Outdated
- install the gems with single command `BUNDLE_GEMFILE=Gemfile.local bundle install`
- alternatively, define the environment variable in your shell profile or .env file `export BUNDLE_GEMFILE=Gemfile.local` and then install with `bundle install`

Enjoy the gems that have been installed locally just for you. Remember, the changes in the Gemfile have not been committed, and the gems are not installed for anyone else. Don’t forget to add these lines to your `.gitignore` file:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Enjoy the gems that have been installed locally just for you. Remember, the changes in the Gemfile have not been committed, and the gems are not installed for anyone else. Don’t forget to add these lines to your `.gitignore` file:
The changes made in the local Gemfile should not be committed. Therefore, add it to `~/.gitignore` file. Note, it's a global config to eliminate any commits into the repo:

README.md Outdated
Gemfile.local.lock
```

If you want to commit changes into the original Gemfile, you should unset the BUNDLE_GEMFILE environment variable using `unset BUNDLE_GEMFILE` or temprorary set it to the original Gemfile with `BUNDLE_GEMFILE=Gemfile bundle install`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please, add a link here for the article - https://blog.widefix.com/personal-gemfile-for-development/

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your comments :)
Should I follow the steps described in the 'Development' section of the README before requesting a pull?

@ka8725
Copy link
Member

ka8725 commented Apr 18, 2024

Closing in favor of #51

Thanks for your contribution @mikitsik !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make it work without being included in Gemfile
2 participants