Rails which files to ignore for GIT

Question

I created a GIT repo, locally. I now see a bunch of files i rather ignore for GIT check-in. This brings me to the question: is there any default .gitignore for Rails? Any best practices?

I think of tmp and log for sure. But are there any other files or folders i should consider?

Rails should have generated a `.gitignore` file for you with the most common non-source-control files included already — Gareth, Mar 08 '12 at 10:45

score 83 · Accepted Answer · edited Jun 13 '23 at 22:29

83

Github has sample .gitignore files for almost any kind of project known to humanity in their github/gitignore repository.

There is one specifically for Rails: Rails.gitignore

edited Jun 13 '23 at 22:29

BinaryButterfly

18,137
13
50
91

answered Mar 08 '12 at 10:49

Ekin Koc

2,996
20
24

2

This answer is incredibly awesome. – Lester Peabody Jan 15 '13 at 04:19
1

I need a "favorite answer" star system. – Kheldar Mar 15 '16 at 10:05
The Rails file under this Repo is at https://github.com/github/gitignore/blob/main/Rails.gitignore – morganwebdev Dec 16 '22 at 03:05

score 13 · Answer 2 · answered Mar 08 '12 at 10:50

this is a gitignore from a relatively large Rails 3.2 app (created with Rails 3.1)

/.bundle
/db/*.sqlite3
/log/*.log
/tmp
config/database.yml
config/google_analytics.yml
.DS_Store
/nbproject/
public/assets/**

just the basic gitignore which comes with rails and added some developer specific stuff like Netbeans project stuff, the .DS_Store from OS X

and we don't like passwords in our repository, so we add all yml files with passwords to gitignore

we also added public/assets/** since we deploy our apps with capistrano and generate the assets during the deploy and push them to amazon

thx. i need to look into that, since it was not working. Weird. — Roger, Mar 08 '12 at 11:06

score 2 · Answer 3 · answered Jan 26 '15 at 03:01

Make use of this GITIGNORE.IO

### Rails ###
*.rbc
capybara-*.html
.rspec
/log
/tmp
/config/database.yml
/db/*.sqlite3
/db/*.sqlite3-journal
/public/system
/coverage/
/spec/tmp
**.orig
rerun.txt
pickle-email-*.html

# TODO Comment out these rules if you are OK with secrets being uploaded to the repo
config/initializers/secret_token.rb
config/secrets.yml

## Environment normalisation:
/.bundle
/vendor/bundle

# these should all be checked in to normalise the environment:
# Gemfile.lock, .ruby-version, .ruby-gemset

# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
.rvmrc

# if using bower-rails ignore default bower_components path bower.json files
/vendor/assets/bower_components
*.bowerrc
bower.json

#Ignore pow enironment settings
.powenv

score 2 · Answer 4 · answered Mar 08 '12 at 11:11

.git/info/exclude If you wish the exclude patterns based on repositories , you may instead put them in a file in that specific repository named .git/info/exclude or core.excludesfile

.gitignore is used to add files which you don't want to be tracked. If the file is already being tracked and you want to add to .gitignore. run git rm --cached filename

score 1 · Answer 5 · answered Mar 08 '12 at 10:47

1

Rails already generate a .gitignore file for you with good defaults. You think right, in fact the .gitignore generated by rails already ignores tmp and log file (and the DBs too).

answered Mar 08 '12 at 10:47

Aldo 'xoen' Giambelluca

12,075
7
33
39

must be hidden @Rogier – aandis Dec 18 '14 at 18:32
@zack, nah it was not there (i know hidden are staring with . [dot]). – Roger Dec 18 '14 at 22:38

score 0 · Answer 6 · answered Jul 21 '23 at 06:42

0

Here's the direct link to the Rails gitignore file. It is up I found this by a simple google search.

You can modify it as per your project/tools settings. I had to add .idea/ to it which is automatically generated by Rubymine.

answered Jul 21 '23 at 06:42

mansoor.khan

2,309
26
39

Rails which files to ignore for GIT

6 Answers6

Linked