Skip to content

Conversation

@nothke
Copy link

@nothke nothke commented Jun 18, 2024

Now it works in 0.14.0-dev.2+0884a4341, and added a gitignore

/debug/
/build/
/build-*/
/docgen_tmp/
Copy link
Owner

Choose a reason for hiding this comment

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

What are the ones from /release/ to /docgen_tmp/ I have never seen these, what does generate those?

@SimonLSchlee
Copy link
Owner

I wanted to create commits and tags for the stable zig versions, 0.12.0 and 0.13.0, I have done that now.

I am not sure the .gitignore is really needed, personally I keep .zig-cache and zig-out in my global gitignore, that way I don't need a .gitignore for every simple zig project.

If you think it is worth adding the .gitignore anyway I could be convinced, but I don't think it should contain these other directories, that seem like legacy stuff to me.
If you rebase on current master and remove those extra directories or explain how they are relevant/useful to ignore, I will merge it.

I don't really think that changing the version number in the build.zig.zon is necessary because users are likely to just copy this repo, delete the .git and change stuff, from that standpoint keeping it on 0.0.1 makes more sense.

I want to avoid clutter and keep the commit history simple.

@nothke
Copy link
Author

nothke commented Jun 28, 2024

This gitignore is the official Zig one made by Andrew: https://github.com/ziglang/zig/blob/master/.gitignore, so it is useful not just for this template but for anything a user might make.

What you are saying is that the users are required to have a global gitignore, which most don't. I don't. And so their git will be cluttered with zig out files and might commit them if not careful. If you really don't like it, you can always delete it, I think it makes sense to keep it in.

@SimonLSchlee
Copy link
Owner

This gitignore is the official Zig one made by Andrew: https://github.com/ziglang/zig/blob/master/.gitignore, so it is useful not just for this template but for anything a user might make.

It is the .gitignore of the zig source code, I don't think that makes it the official .gitignore for zig projects, if it was official I would expect zig init to also generate it, or maybe at least with a hypothetical zig init --use-git command.
These extra directories still seem like some legacy entries to me, or maybe they are relevant to the workflow of the zig source code repository, I don't think that makes those relevant in all zig projects in general.

What you are saying is that the users are required to have a global gitignore, which most don't. I don't. And so their git will be cluttered with zig out files and might commit them if not careful.

I think taking the 5-10 minutes to configure your global gitignore is the better way and I prefer that because it seems easier in the long term to me than adding this to every repository, but that is my personal opinion.

So I will accept adding a .gitignore, but remove those other directories or explain why they are necessary, they don't seem to be generated by normal zig tools for normal projects, I think those other directories are something that only happens in the zig source repo / with special workflows.

@ar-qun
Copy link

ar-qun commented Oct 5, 2024

I think this PR is trying to do to many things at the same time. Why not split it into 3-4 different PRs?

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