Hide standard linting commit
#1746
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
StuAA78
added
enhancement
Cruikshanks
approved these changes
Aug 4, 2022
StuAA78
added a commit
to DEFRA/water-abstraction-system
that referenced
this pull request
Nov 27, 2024
[Our move away from Standard](#1476) has involved a huge number of changes. In order to preserve the `git blame` record, we create a `.git-blame-ignore-revs` file, which we can use to ignore specific commits. We previously introduced it to our other repos when implementing Standard: DEFRA/water-abstraction-team#37 DEFRA/water-abstraction-service#1746 This PR creates the file for this repo with the required commit to ignore the large-scale linting changes. Note that while GitHub supports this file, it's up to us to configure our local repo to make use of it. This can be done with: ```bash git config blame.ignorerevsfile .git-blame-ignore-revs ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DEFRA/water-abstraction-team#37
This change creates a
.git-blame-ignore-revsfile containing the sha of the commit that switched from using ES Lint and semi-standard to plain old JS standard. This will hide this commit ingit blame(given the correct config option) and in GitHub's blame view.GitLens
If you use a tool such as GitLens which shows
git blameinfo in the IDE, you can check its effect by first viewing a file which was changed, eg.src/lib/camel-case-keys.js:Now pull down the branch and enter the following command in your
water-abstraction-servicefolder to configuregit blameto use.git-blame-ignore-revs:Close and re-open the file and you'll see the output of
git blamenow ignores that commit:Note that the configuration option will break
git blameif you revert to a branch which doesn't have.git-blame-ignore-revs. You can remove it by running the following command in yourwater-abstraction-servicefolder:We recommend you don't set
blame.ignorerevsfileglobally as this will stopgit blamefrom working for any folder which doesn't have a.git-blame-ignore-revsfile! Better to set the option for each folder individually as and when they're updated with.git-blame-ignore-revs.GitHub
The difference in GitHub's blame view can be seen here:
Before:
After:
