Support `.git-blame-ignore-revs` file #26395

KN4CK3R · 2023-08-08T12:23:31Z

This PR adds the ability to ignore revisions specified in the .git-blame-ignore-revs file in the root of the repository.

The banner is displayed in this case. I intentionally did not add a UI way to bypass the ignore file (same behaviour as Github) but you can add ?bypass-blame-ignore=true to the url manually.

…-blame-ignore-revs

KN4CK3R · 2023-08-09T14:01:14Z

modules/git/blame.go

+		ignoreRevsFile = tryCreateBlameIgnoreRevsFile(commit)
+		if ignoreRevsFile != nil {
+			cmd.AddOptionValues("--ignore-revs-file", ignoreRevsFile.Name())
+		}


It would be better to use --ignore-revs-file /dev/stdin and pass the content of the .git-blame-ignore-revs file but there is no Windows equivalent for /dev/stdin.

We could think about creating a unix and windows variant where the windows variant uses an actual file while the UNIX variant uses stdin…

options/locale/locale_en-US.ini

routers/web/repo/blame.go

modules/git/blame.go

delvh · 2023-08-13T08:41:10Z

modules/git/blame.go

+		ignoreRevsFile = tryCreateBlameIgnoreRevsFile(commit)
+		if ignoreRevsFile != nil {
+			cmd.AddOptionValues("--ignore-revs-file", ignoreRevsFile.Name())
+		}


We could think about creating a unix and windows variant where the windows variant uses an actual file while the UNIX variant uses stdin…

modules/git/blame.go

delvh · 2023-08-13T08:49:41Z

Oh, by the way, this feature needs documentation.
Especially since we deviate from GitHub.

…-blame-ignore-revs

KN4CK3R · 2023-08-13T17:49:36Z

Especially since we deviate from GitHub.

You talk about the bypass parameter? The other functionality is identical to Github.

delvh · 2023-08-13T17:52:23Z

Yes.

Forgot that documentation is still missing. Once it is present LGTM.

…-blame-ignore-revs

wxiaoguang · 2023-08-30T15:34:59Z

modules/git/blame.go

 	output         io.WriteCloser
 	reader         io.ReadCloser
 	bufferedReader *bufio.Reader
 	done           chan error
 	lastSha        *string
+	ignoreRevsFile *os.File


It seems strange to store a closed File here. Maybe using ignoreRevsFileName string is good enough?

Otherwise it's not easy to understand when the file should be closed.

I used os.File here to have an explicit nil check. Sure a != "" check works too but my intent was to have a real file linked to the object. How about changing this member to os.FileInfo? That should be the best of both worlds.

but my intent was to have a real file linked to the object.

But the file has been closed, the object itself can't do other things except accessing the f.Name(), which is simply { return f.name }

modules/git/blame.go

wxiaoguang · 2023-08-30T15:41:39Z

templates/repo/blame.tmpl

+	{{$revsFileLink := URLJoin .RepoLink "src" .BranchNameSubURL "/.git-blame-ignore-revs"}}
+	{{if .UsesIgnoreRevs}}
+		<div class="ui info message">
+			<p>{{.locale.Tr "repo.blame.ignore_revs" $revsFileLink | Str2html}}</p>


Maybe it could add ?bypass-blame-ignore=true link here, than no need to write the document, and it's more friendly to end users?

Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>

…-blame-ignore-revs

…R/gitea into feature-blame-ignore-revs

* giteaoffical/main: (23 commits) Search branches (go-gitea#27055) Fix wrong migration for email address (go-gitea#27106) [skip ci] Updated translations via Crowdin Support `.git-blame-ignore-revs` file (go-gitea#26395) Add `RemoteAddress` to mirrors (go-gitea#26952) Upgrading the actions/checkout@4 (go-gitea#27096) Next round of `db.DefaultContext` refactor (go-gitea#27089) Ui correction in mobile view nav bar left aligned items. (go-gitea#27046) Add missing deps to files-changed (go-gitea#27100) Use db.WithTx for AddTeamMember to avoid ctx abuse (go-gitea#27095) Drop Node.js 16 and update js dependencies (go-gitea#27094) Fix NPE when editing OAuth2 applications (go-gitea#27078) Use `print` instead of `printf` (go-gitea#27093) Add tests for db indexer in indexer_test.go (go-gitea#27087) [skip ci] Updated translations via Crowdin Allow empty Conan files (go-gitea#27092) Actions are no longer experimental, so enable them by default (go-gitea#27054) Update brew installation documentation since gitea moved to brew core package (go-gitea#27070) More refactoring of `db.DefaultContext` (go-gitea#27083) [skip ci] Updated translations via Crowdin ...

* origin/main: (53 commits) Search branches (go-gitea#27055) Fix wrong migration for email address (go-gitea#27106) [skip ci] Updated translations via Crowdin Support `.git-blame-ignore-revs` file (go-gitea#26395) Add `RemoteAddress` to mirrors (go-gitea#26952) Upgrading the actions/checkout@4 (go-gitea#27096) Next round of `db.DefaultContext` refactor (go-gitea#27089) Ui correction in mobile view nav bar left aligned items. (go-gitea#27046) Add missing deps to files-changed (go-gitea#27100) Use db.WithTx for AddTeamMember to avoid ctx abuse (go-gitea#27095) Drop Node.js 16 and update js dependencies (go-gitea#27094) Fix NPE when editing OAuth2 applications (go-gitea#27078) Use `print` instead of `printf` (go-gitea#27093) Add tests for db indexer in indexer_test.go (go-gitea#27087) [skip ci] Updated translations via Crowdin Allow empty Conan files (go-gitea#27092) Actions are no longer experimental, so enable them by default (go-gitea#27054) Update brew installation documentation since gitea moved to brew core package (go-gitea#27070) More refactoring of `db.DefaultContext` (go-gitea#27083) [skip ci] Updated translations via Crowdin ...

KN4CK3R added 2 commits August 7, 2023 19:13

Add ability to ignore revs.

1aeb8f2

Merge branch 'main' of https://github.com/go-gitea/gitea into feature…

b2d9961

…-blame-ignore-revs

KN4CK3R added type/feature Completely new functionality. Can only be merged if feature freeze is not active. pr/wip This PR is not ready for review labels Aug 8, 2023

GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Aug 8, 2023

pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 8, 2023

KN4CK3R marked this pull request as draft August 8, 2023 12:24

KN4CK3R commented Aug 9, 2023

View reviewed changes

KN4CK3R changed the title ~~[WIP] Support git-blame-ignore-revs file~~ Support git-blame-ignore-revs file Aug 10, 2023

KN4CK3R removed the pr/wip This PR is not ready for review label Aug 10, 2023

KN4CK3R marked this pull request as ready for review August 10, 2023 14:54

delvh reviewed Aug 13, 2023

View reviewed changes

delvh changed the title ~~Support git-blame-ignore-revs file~~ Support .git-blame-ignore-revs file Aug 13, 2023

KN4CK3R added 2 commits August 13, 2023 17:09

Merge branch 'main' of https://github.com/go-gitea/gitea into feature…

e1a0ade

…-blame-ignore-revs

Handle faulty .git-blame-ignore-revs files.

734048b

delvh previously approved these changes Aug 13, 2023

View reviewed changes

GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Aug 13, 2023

GiteaBot added lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Aug 13, 2023

KN4CK3R added 5 commits August 14, 2023 18:33

Add docs.

4125e33

Merge branch 'main' of https://github.com/go-gitea/gitea into feature…

c482da4

…-blame-ignore-revs

Merge branch 'main' of https://github.com/go-gitea/gitea into feature…

ac922ee

…-blame-ignore-revs

Merge branch 'main' into feature-blame-ignore-revs

276e11b

Merge branch 'main' into feature-blame-ignore-revs

61b079b

delvh approved these changes Aug 30, 2023

View reviewed changes

GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Aug 30, 2023

wxiaoguang reviewed Aug 30, 2023

View reviewed changes

KN4CK3R and others added 4 commits August 30, 2023 23:33

Update modules/git/blame.go

2da7857

Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>

Apply suggestions.

d01b712

Merge branch 'main' of https://github.com/go-gitea/gitea into feature…

b4a1ab7

…-blame-ignore-revs

Merge branch 'feature-blame-ignore-revs' of https://github.com/KN4CK3…

833c640

…R/gitea into feature-blame-ignore-revs

github-actions bot added the type/docs This PR mainly updates/creates documentation label Sep 15, 2023

wxiaoguang approved these changes Sep 16, 2023

View reviewed changes

GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Sep 16, 2023

KN4CK3R enabled auto-merge (squash) September 16, 2023 17:16

Merge branch 'main' into feature-blame-ignore-revs

8d9e575

KN4CK3R merged commit ed64f1c into go-gitea:main Sep 16, 2023
25 checks passed

GiteaBot added this to the 1.22.0 milestone Sep 16, 2023

delvh modified the milestones: 1.22.0, 1.21.0 Sep 16, 2023

KN4CK3R deleted the feature-blame-ignore-revs branch September 18, 2023 10:10

go-gitea locked as resolved and limited conversation to collaborators Dec 16, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support `.git-blame-ignore-revs` file #26395

Support `.git-blame-ignore-revs` file #26395

KN4CK3R commented Aug 8, 2023 •

edited

Loading

KN4CK3R Aug 9, 2023

delvh Aug 13, 2023

delvh Aug 13, 2023

delvh commented Aug 13, 2023

KN4CK3R commented Aug 13, 2023

delvh commented Aug 13, 2023

wxiaoguang Aug 30, 2023

KN4CK3R Aug 30, 2023

wxiaoguang Aug 31, 2023

wxiaoguang Aug 30, 2023

Support .git-blame-ignore-revs file #26395

Support .git-blame-ignore-revs file #26395

Conversation

KN4CK3R commented Aug 8, 2023 • edited Loading

KN4CK3R Aug 9, 2023

Choose a reason for hiding this comment

delvh Aug 13, 2023

Choose a reason for hiding this comment

delvh Aug 13, 2023

Choose a reason for hiding this comment

delvh commented Aug 13, 2023

KN4CK3R commented Aug 13, 2023

delvh commented Aug 13, 2023

wxiaoguang Aug 30, 2023

Choose a reason for hiding this comment

KN4CK3R Aug 30, 2023

Choose a reason for hiding this comment

wxiaoguang Aug 31, 2023

Choose a reason for hiding this comment

wxiaoguang Aug 30, 2023

Choose a reason for hiding this comment

Support `.git-blame-ignore-revs` file #26395

Support `.git-blame-ignore-revs` file #26395

KN4CK3R commented Aug 8, 2023 •

edited

Loading