cleaning .gitignore #740

kuritka · 2021-11-15T18:31:22Z

please try the local branch to see if everything works as expected.
Because things in .gitignore were repetitive and didn't make much sense, I refactored .gitignore.

We stayed in denyList mode.
~~It has two sections~~
- ~~the first section is generated by toptal.com for vim,go,goland,visualstudiocode,emacs,jekyll~~
- ~~the second section follows the first one and is for custom rules of our project.~~

Signed-off-by: kuritka kuritka@gmail.com

.gitignore

kuritka · 2021-11-16T05:40:23Z

Good points @jkremser, gitignore in this case is generated by https://www.toptal.com/developers/gitignore (which was partly last time too). Only the end of the file (custom section) contains custom rules.

k0da · 2021-11-16T15:14:48Z

just for curioucity, is it just IDE runs git add . when handling git? Never had a usecase for git ignore except goreleaser when it requires clean state to perform a release (but IIRC this only relates to tracked files)

somaritane

@kuritka I think it makes sense to follow the YAGNI (You Ain't Gonna Need It) principle here and leave only those filters that are relevant to the k8gb project nature and the tooling it uses.
So I would not add auto-generated filters at all, but instead, even further remove unnecessary ones, if we talk about .gitignore cleaning.

ytsarev

I will second @somaritane here. Let's put only project-related entries into .gitignore

kuritka · 2021-11-18T09:49:54Z

.gitignore optimized

ytsarev · 2021-11-18T10:15:41Z

.gitignore

 chart/k8gb/charts/*.tgz

-# Ignore testing kubeconfigs
-kubeconfig*


Can we please leave it around? I'm using it for testing over multiple clusters from time to time avoiding tampering the main kubeconfig

@ytsarev This looks like a user-specific, not project-specific thing :) i.e. you can export KUBECONFIG= to point to any kubeconfig path of your like, shouldn't be necessary lying in the k8gb working copy. Or am I missing something?

@somaritane looks like project creator specific thing yes ;) it is just two lines to speed up my productivity, I am not asking for too much, I think :)
Re kubeconfigs - I prefer to temporary keep them to the project under test, the matter of convenience

@somaritane following the same logic, you could also use vim and we could drop .vscode and .idea ;)

Also kubeconfigs are somehow related to k8s operator project :D Sorry, now I will not give it up so easily :D

@somaritane works for me, i will sacrifice my kubeconfigs for that :D

I am also in favor of removing IDE specific settings, I left it there more because for most contributors this is too confusing.

pls keep .idea & .vscode also there, I have both in my global .gitignore, but still if it's not there it makes contributing (for external ppl w/ random editors) harder. The chances of using either vs code or idea are pretty high these days

I don't see anything wrong w/ putting ide specific one-liners for IGNORING the configs (like .idea) what seemed weird to me were those !.vscode/tasks.json "keep-ide-specific-stuff-in-repo" rules

btw. I had to add those two specific rules to my .gitignore to be able to work comfortly w/ k8gb:

... /.custom-env/* ... custom env files that can be consumed by debug/run configurations in goland /k8gb ... binary file we produce when doing `go build`

just in case, if we leave the DenyListing .gitignore and switch to AllowListing .gitignore instead, we will only allow what is actually part of the project.

The chances of using either vs code or idea are pretty high these days
@jkremser This statement is subjective without stats :).

I just hope that If we leave .gitignore for vim, idea, vscode, then we're ready to accept PRs to add emacs, sublime, atom, eclipse, komodo etc (sits pretty well in random editor category with Golang support available) on request in the future, denying such requests would be unfair.

But as I said, if I have my IDE of choice, asking every single project to include it in its .gitignore won't scale.

.gitignore

please try the local branch to see if everything works as expected. Because things in .gitignore were repetitive and didn't make much sense, I refactored .gitignore. - We stayed in denyList mode. - ~~It has two sections~~ - ~~the first section is generated by [toptal.com](https://www.toptal.com/developers/gitignore) for vim,go,goland,visualstudiocode,emacs,jekyll~~ - ~~the second section follows the first one and is for custom rules of our project.~~ Signed-off-by: kuritka <kuritka@gmail.com>

ytsarev

Looks like good cleanup. LGTM

jkremser · 2021-11-18T13:37:25Z

.gitignore

-.*.sw[a-p]
-# session
+*.sw[ap]
+k8gb


somaritane

btw. I had to add those two specific rules to my .gitignore to be able to work comfortly w/ k8gb:

@kuritka I think we should add k8gb to .gitignore because this is project-specific thing.

somaritane

@kuritka sorry, didn't see k8gb binary is already included.
Thanks a lot for the tremendous effort, LGTM! 👍

please try the local branch to see if everything works as expected. Because things in .gitignore were repetitive and didn't make much sense, I refactored .gitignore. - We stayed in denyList mode. - ~~It has two sections~~ - ~~the first section is generated by [toptal.com](https://www.toptal.com/developers/gitignore) for vim,go,goland,visualstudiocode,emacs,jekyll~~ - ~~the second section follows the first one and is for custom rules of our project.~~ Signed-off-by: kuritka <kuritka@gmail.com> Signed-off-by: Jirka Kremser <jiri.kremser@gmail.com>

kuritka requested review from donovanmuller, jkremser, k0da, somaritane and ytsarev as code owners November 15, 2021 18:31

k0da reviewed Nov 15, 2021

View reviewed changes

.gitignore Show resolved Hide resolved

kuritka force-pushed the clean-gitignore branch from 39079d7 to bac0ad7 Compare November 15, 2021 18:41

kuritka requested a review from k0da November 15, 2021 18:45

jkremser reviewed Nov 15, 2021

View reviewed changes

.gitignore Show resolved Hide resolved

.gitignore Outdated Show resolved Hide resolved

.gitignore Outdated Show resolved Hide resolved

kuritka mentioned this pull request Nov 16, 2021

.gitignore k8gb chart dependency .tgz files at gh-pages branch #743

Merged

somaritane reviewed Nov 17, 2021

View reviewed changes

ytsarev requested changes Nov 18, 2021

View reviewed changes

kuritka force-pushed the clean-gitignore branch from bac0ad7 to 5338ccf Compare November 18, 2021 09:34

kuritka requested review from somaritane, ytsarev and jkremser November 18, 2021 09:44

ytsarev requested changes Nov 18, 2021

View reviewed changes

somaritane reviewed Nov 18, 2021

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

kuritka force-pushed the clean-gitignore branch from 5338ccf to 19b63bb Compare November 18, 2021 10:36

somaritane reviewed Nov 18, 2021

View reviewed changes

.gitignore Show resolved Hide resolved

.gitignore Show resolved Hide resolved

kuritka force-pushed the clean-gitignore branch 3 times, most recently from b0c2753 to 5bb9d47 Compare November 18, 2021 11:16

kuritka force-pushed the clean-gitignore branch from 5bb9d47 to aded99c Compare November 18, 2021 11:17

ytsarev approved these changes Nov 18, 2021

View reviewed changes

jkremser approved these changes Nov 18, 2021

View reviewed changes

.gitignore

.*.sw[a-p]

# session

*.sw[ap]

k8gb

Copy link

Member

jkremser Nov 18, 2021

Choose a reason for hiding this comment

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

❤️

somaritane reacted with thumbs up emoji kuritka reacted with rocket emoji

somaritane suggested changes Nov 18, 2021

View reviewed changes

somaritane approved these changes Nov 18, 2021

View reviewed changes

kuritka merged commit e036573 into master Nov 18, 2021

kuritka deleted the clean-gitignore branch November 18, 2021 14:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cleaning .gitignore #740

cleaning .gitignore #740

kuritka commented Nov 15, 2021 •

edited

kuritka commented Nov 16, 2021 •

edited

k0da commented Nov 16, 2021

somaritane left a comment

ytsarev left a comment

kuritka commented Nov 18, 2021

ytsarev Nov 18, 2021

somaritane Nov 18, 2021

ytsarev Nov 18, 2021 •

edited

ytsarev Nov 18, 2021

ytsarev Nov 18, 2021

ytsarev Nov 18, 2021

kuritka Nov 18, 2021 •

edited

jkremser Nov 18, 2021

kuritka Nov 18, 2021 •

edited

somaritane Nov 18, 2021

ytsarev left a comment

jkremser Nov 18, 2021

somaritane left a comment

somaritane left a comment

cleaning .gitignore #740

cleaning .gitignore #740

Conversation

kuritka commented Nov 15, 2021 • edited

kuritka commented Nov 16, 2021 • edited

k0da commented Nov 16, 2021

somaritane left a comment

Choose a reason for hiding this comment

ytsarev left a comment

Choose a reason for hiding this comment

kuritka commented Nov 18, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ytsarev Nov 18, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kuritka Nov 18, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kuritka Nov 18, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ytsarev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

somaritane left a comment

Choose a reason for hiding this comment

somaritane left a comment

Choose a reason for hiding this comment

kuritka commented Nov 15, 2021 •

edited

kuritka commented Nov 16, 2021 •

edited

ytsarev Nov 18, 2021 •

edited

kuritka Nov 18, 2021 •

edited

kuritka Nov 18, 2021 •

edited