gitignore/Rails.gitignore

*.rbc
capybara-*.html
.rspec
/db/*.sqlite3
/db/*.sqlite3-journal
/db/*.sqlite3-[0-9]*
/public/system
/coverage/
/spec/tmp
*.orig
rerun.txt
pickle-email-*.html

# Ignore all logfiles and tempfiles.
/log/*
/tmp/*
!/log/.keep
!/tmp/.keep

# TODO Comment out this rule if you are OK with secrets being uploaded to the repo
config/initializers/secret_token.rb
config/master.key

# Only include if you have production secrets in this file, which is no longer a Rails default
# config/secrets.yml

# dotenv, dotenv-rails
# TODO Comment out these rules if environment variables can be committed
.env
.env*.local

## Environment normalization:
/.bundle
/vendor/bundle

# these should all be checked in to normalize 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 environment settings
.powenv

# Ignore Byebug command history file.
.byebug_history

# Ignore node_modules
node_modules/

# Ignore precompiled javascript packs
/public/packs
/public/packs-test
/public/assets

# Ignore yarn files
/yarn-error.log
yarn-debug.log*
.yarn-integrity

# Ignore uploaded files in development
/storage/*
!/storage/.keep
/public/uploads
Ignore Rubinius compiled files 2010-11-09 05:11:38 +08:00			`*.rbc`
rspec config file and capybara generated files 2010-11-09 07:20:34 +08:00			`capybara-*.html`
			`.rspec`
Unless full paths are used .gitignore, all matching files and folders will be ignored, however deep they are in the repo. For example, ignoring log/* doesn't just ignore all log files, but also files such as lib/project/log/awesome_logger.rb. It's a mistake I've made a couple of times but never seemed to have learned from. 2010-11-09 15:25:48 +08:00			`/db/*.sqlite3`
Added *.sqlite3-journal to Rails.gitignore 2014-11-13 16:34:19 +08:00			`/db/*.sqlite3-journal`
Upgrate to rails 6.0.0 (#3167) * Upgrate to rails 6.0.0 * Simplify Rails.gitignore 2019-09-10 22:08:25 +08:00			`/db/.sqlite3-[0-9]`
Ignore Rails directories instead of their files 2013-01-24 16:47:17 +08:00			`/public/system`
Unless full paths are used .gitignore, all matching files and folders will be ignored, however deep they are in the repo. For example, ignoring log/* doesn't just ignore all log files, but also files such as lib/project/log/awesome_logger.rb. It's a mistake I've made a couple of times but never seemed to have learned from. 2010-11-09 15:25:48 +08:00			`/coverage/`
Ignore Rails directories instead of their files 2013-01-24 16:47:17 +08:00			`/spec/tmp`
Double-asterisk misuse `**.` is invalid 2017-03-24 00:09:50 +08:00			`*.orig`
added pickle generated files 2010-11-25 02:34:00 +08:00			`rerun.txt`
add .project files to .gitignore .project files come from Aptana Studio, a Rails IDE. 2012-10-31 01:05:22 +08:00			`pickle-email-*.html`
add notice about secret files 2014-04-05 06:25:30 +08:00
Don't ignore tmp and log directory (#2999) https://weblog.rubyonrails.org/2019/3/13/Rails-4-2-5-1-5-1-6-2-have-been-released/ Rails `5.2.2.1` requires `tmp` directory committed to git repository for CI to run successfully. 2019-03-14 20:55:38 +08:00			`# Ignore all logfiles and tempfiles.`
			`/log/*`
			`/tmp/*`
			`!/log/.keep`
			`!/tmp/.keep`

Remove config/secrets.yml Rails no longer generates this file with sensitive secrets (default now is to do `secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>` in production). 2016-08-09 02:38:53 +08:00			`# TODO Comment out this rule if you are OK with secrets being uploaded to the repo`
added secret_token.rb I added secret_token.rb file to the gitignore as there are public repos sharing it. 2013-08-13 01:40:19 +08:00			`config/initializers/secret_token.rb`
Add exclude credential master key of Rails 5.2 2018-03-28 21:19:32 +08:00			`config/master.key`
Remove config/secrets.yml Rails no longer generates this file with sensitive secrets (default now is to do `secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>` in production). 2016-08-09 02:38:53 +08:00
			`# Only include if you have production secrets in this file, which is no longer a Rails default`
			`# config/secrets.yml`
Annotate .env addition 2016-05-12 17:02:05 +08:00
Add .env.* to optionally ignored files in Rails.gitignore. (#3065) 2019-12-06 18:05:44 +08:00			`# dotenv, dotenv-rails`
			`# TODO Comment out these rules if environment variables can be committed`
Add .env to optionally ignored files Many twelve-factor apps use environment variables rather than the built in Rails secrets mechanism to store secrets. The [dotenv](https://github.com/bkeepers/dotenv) gem is widely used for this purpose and allows environment variables to be loaded from the `.env` file. However, this file should not be committed to source control. This PR just adds the `.env` file to `.gitignore` so that these secrets aren't accidentally committed. In some rare instances, it may be required that this file is committed to source control so I've added it to the list of files that can be removed if the developer is ok with secrets being committed. 2016-05-12 15:53:20 +08:00			`.env`
Ignore Rails .env according recomendations Reasons for making this change: Rails dotenv ignore is not following dotenv recommendations as stated in its documentation Links to documentation supporting these rule changes: https://github.com/bkeepers/dotenv#what-other-env-files-can-i-use 2021-10-28 15:52:49 +08:00			`.env*.local`
Optionally ignore ruby env normalisation files, with comments 2013-11-10 18:12:01 +08:00
Fix few typos 2015-12-13 22:07:46 +08:00			`## Environment normalization:`
Optionally ignore ruby env normalisation files, with comments 2013-11-10 18:12:01 +08:00			`/.bundle`
			`/vendor/bundle`

Fix few typos 2015-12-13 22:07:46 +08:00			`# these should all be checked in to normalize the environment:`
Join comments in rails template 2013-11-10 18:39:33 +08:00			`# Gemfile.lock, .ruby-version, .ruby-gemset`
Optionally ignore ruby env normalisation files, with comments 2013-11-10 18:12:01 +08:00
			`# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:`
			`.rvmrc`
Add ignores for bower-rails bower-rails integrates bower.io into Rails, it allows you to have everything in a Bowerfile and install all vendor assets easily. 2014-07-19 05:11:42 +08:00
			`# if using bower-rails ignore default bower_components path bower.json files`
			`/vendor/assets/bower_components`
			`*.bowerrc`
			`bower.json`
Ignoring Pow environment settings 2014-10-21 17:50:16 +08:00
Typo in comment I know this is petty, but imagine thousand upon thousand of corrective commits saved by fixing the typo right into the heart of the file. 2015-01-21 16:30:32 +08:00			`# Ignore pow environment settings`
Targeted more specifically pow files 2014-11-18 16:55:58 +08:00			`.powenv`
Add .byebug_history to gitignore .byebug_history included in default Rails5 setup (https://github.com/rails/rails/blob/master/railties/lib/rails/generators/rails/app/templates/gitignore) 2016-01-24 01:56:49 +08:00
			`# Ignore Byebug command history file.`
			`.byebug_history`
Ignore node_modules (#2538) Rails 5 uses npm to handle javascript dependancies, node_modules should not be checked in to git. 2017-12-15 10:11:09 +08:00
			`# Ignore node_modules`
			`node_modules/`

Add storage and yarn related entries for rails 5.2 2018-09-03 14:24:10 +08:00			`# Ignore precompiled javascript packs`
			`/public/packs`
			`/public/packs-test`
Ignore public/assets in Rails .gitignore 2018-10-06 13:28:22 +08:00			`/public/assets`
Add storage and yarn related entries for rails 5.2 2018-09-03 14:24:10 +08:00
			`# Ignore yarn files`
			`/yarn-error.log`
			`yarn-debug.log*`
			`.yarn-integrity`

			`# Ignore uploaded files in development`
			`/storage/*`
Don't ignore tmp and log directory (#2999) https://weblog.rubyonrails.org/2019/3/13/Rails-4-2-5-1-5-1-6-2-have-been-released/ Rails `5.2.2.1` requires `tmp` directory committed to git repository for CI to run successfully. 2019-03-14 20:55:38 +08:00			`!/storage/.keep`
Add /public/uploads for file upload gem Shrine (#3333) When using a file upload gem called Shrine, its file system mode put images under `public/uploads`. https://github.com/shrinerb/shrine/blob/053bcf297e092e9695731fb9b67a86780e898203/doc/storage/file_system.md 2020-03-11 20:54:02 +08:00			`/public/uploads`