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.

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

[githooks] Remove #4761

Merged
merged 6 commits into from
Jan 9, 2024
Merged

[githooks] Remove #4761

merged 6 commits into from
Jan 9, 2024

Conversation

zmt
Copy link
Contributor

@zmt zmt commented Dec 27, 2023

The instructions as written in CONTRIBUTING.md resulted in a broken link for the pre-commit git hook. Per discussion with maintainers, the gofmt pre-commit hook is essentially obsolete. Rather than correct the documentation, just remove it and the reference to it in CONTRIBUTING.md.

Pull Request check list

  • Commit conforms to CONTRIBUTING.md
  • Proper tests/regressions included?
  • Documentation updated

Affected functionality
Remove the pre-commit git hook and broken symlink instructions.

Description of change
Started as a documentation fix, but became removal of dead code.

The instructions as written resulted in a broken link for the pre-commit
git hook. Use `pushd`, `popd`, and `git rev-parse --show-toplevel` to
correct it.

Signed-off-by: Zack Train <ztrain@uber.com>
@zmt zmt mentioned this pull request Dec 27, 2023
3 tasks
zmt added a commit to zmt/spire that referenced this pull request Dec 27, 2023
Signed-off-by: Zack Train <ztrain@uber.com>
azdagron
azdagron previously approved these changes Jan 2, 2024
@azdagron
Copy link
Member

azdagron commented Jan 2, 2024

This fix is great. As discussed in the contrib sync, it's probably also ok to just remove this git hook and doc section. Most go setups these days do gofmt (or goimports) by default.

@zmt zmt changed the title [docs] Fix git hook bug in CONTRIBUTING.md [githooks] Remove Jan 2, 2024
azdagron
azdagron previously approved these changes Jan 2, 2024
Copy link
Member

@azdagron azdagron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @zmt :)

@MarcosDY
Copy link
Collaborator

MarcosDY commented Jan 3, 2024

@zmt can you resolve conflicts? thanks!!!

@MarcosDY MarcosDY added this to the 1.9.0 milestone Jan 9, 2024
@MarcosDY MarcosDY merged commit fb7eaed into spiffe:main Jan 9, 2024
32 checks passed
sriyer pushed a commit to spire-vault/spire that referenced this pull request Feb 23, 2024
* [docs] Fix git hook bug in CONTRIBUTING.md

The instructions as written resulted in a broken link for the pre-commit
git hook. Use `pushd`, `popd`, and `git rev-parse --show-toplevel` to
correct it.

Signed-off-by: Zack Train <ztrain@uber.com>

* [githooks] Remove deprecated gofmt pre-update hook

Signed-off-by: Zack Train <ztrain@uber.com>

---------

Signed-off-by: Zack Train <ztrain@uber.com>
Co-authored-by: Marcos Yacob <marcos.yacob@hpe.com>
rushi47 pushed a commit to rushi47/spire that referenced this pull request Apr 11, 2024
* [docs] Fix git hook bug in CONTRIBUTING.md

The instructions as written resulted in a broken link for the pre-commit
git hook. Use `pushd`, `popd`, and `git rev-parse --show-toplevel` to
correct it.

Signed-off-by: Zack Train <ztrain@uber.com>

* [githooks] Remove deprecated gofmt pre-update hook

Signed-off-by: Zack Train <ztrain@uber.com>

---------

Signed-off-by: Zack Train <ztrain@uber.com>
Co-authored-by: Marcos Yacob <marcos.yacob@hpe.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants