Skip to content

Commit

Permalink
chore: add .git-blame-ignore-revs file and command
Browse files Browse the repository at this point in the history
  • Loading branch information
coldlink committed Jul 14, 2023
1 parent e837619 commit ab627bf
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
7 changes: 7 additions & 0 deletions .git-blame-ignore-revs
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# File used to ignore revisions in `git blame`

# Make sure you have run `git config blame.ignoreRevsFile .git-blame-ignore-revs`
# to set up your git config to always ignore these revisions.

# Use `@guardian/prettier` config and rewrite files
e83761904cf0dea91f411bb4ca4815660cf25c6b
11 changes: 10 additions & 1 deletion docs/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,20 @@ Need help? Contact the Identity team on [Digital/Identity](https://chat.google.c
## Requirements

- [Node.js](https://nodejs.org) - Version is specified by [.nvmrc](../.nvmrc), run [`$ nvm use`](https://github.com/creationix/nvm#nvmrc) to use it.

- We use [`yarn`](https://classic.yarnpkg.com/en/) for dependency management, so if using Node, make sure to get yarn too.

## Configuration

## `git` setup

Make sure to set up your git config to ignore certain revisions in `git blame` by running:

```sh
$ git config blame.ignoreRevsFile .git-blame-ignore-revs
```

This will ignore specific revision in `git blame` defined in `.git-blame-ignore-revs` file. This is useful for ignoring large commits that are not relevant to the codebase, e.g. prettier rewrites.

### Nginx

You can setup gateway to use a domain name locally (`https://profile.thegulocal.com`) and alongside identity-frontend by following the instructions from [`identity-platform/nginx`](https://github.com/guardian/identity-platform/tree/master/nginx).
Expand Down

0 comments on commit ab627bf

Please sign in to comment.