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 for disabling papertrail within initializer #1176

Closed
wants to merge 1 commit into from
Closed

update readme for disabling papertrail within initializer #1176

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
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,18 +284,22 @@ Syntax example: (options described in detail later)

```ruby
# config/initializers/paper_trail.rb
PaperTrail.config.enabled = true
PaperTrail.config.has_paper_trail_defaults = {
on: %i[create update destroy]
}
PaperTrail.config.version_limit = 3
````

These options are intended to be set only once, during app initialization (eg.
in `config/initializers`). It is unsafe to change them while the app is running.
in `config/initializers` or in an environment-specific configuration file such as
`config/environments/test.rb`). It is unsafe to change them while the app is running.
In contrast, `PaperTrail.request` has various options that only apply to a
single HTTP request and thus are safe to use while the app is running.

Note that `PaperTrails.config.enabled` will be overwritten if it is set within
`config/initializers`. For more information, see
[Turning PaperTrail Off](#2d-turning-papertrail-off) below.

## 2. Limiting What is Versioned, and When

### 2.a. Choosing Lifecycle Events To Monitor
Expand Down Expand Up @@ -503,6 +507,11 @@ PaperTrail.enabled = false
**Do not use this in production** unless you have a good understanding of
threads vs. processes.

Also note that PaperTrail can only be disabled globally during or after
environment-specific initialization. In other words, changes to
`PaperTrail.enabled` (or its alias `PaperTrail.config.enabled`) in
`config/initializers` will be overwritten.

A legitimate use case is to speed up tests. See [Testing](#7-testing) below.

There is also a rails config option that does the same thing.
Expand Down