Skip to content

fix: copy .gitignore files during project initialization #5953

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.

Sign up for GitHub

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

Jump to bottom
Merged
galargh merged 1 commit into from
Dec 4, 2024
Merged

fix: copy .gitignore files during project initialization #5953

galargh merged 1 commit into from
Dec 4, 2024

Conversation

@galargh
Copy link
Contributor

@galargh galargh commented Nov 18, 2024

  • Because this PR includes a bug fix, relevant tests have been included.
  • Because this PR includes a new feature, the change was previously discussed on an Issue or with someone from the team.
  • I didn't do anything of this.

This PR introduces the agreed upon workaround for npms inability to publish .gitignore files (see npm/npm#3763).

Going through the comments on the linked issue, it seems that the most common convention for working around this issue is exactly what we came up with, too - which is to copy gitignore template files as .gitignore workspace files.

I left .gitignore files in the templates because it is useful to have, for example, node_modules gitignored during development.

@galargh galargh requested a review from kanej November 18, 2024 13:14
@changeset-bot
Copy link

changeset-bot bot commented Nov 18, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: dfc0153

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Nov 18, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
hardhat ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 18, 2024 2:05pm

@galargh
Copy link
Contributor Author

galargh commented Nov 19, 2024

Interestingly enough pnpm pack does respect explicit templates/**/.gitignore in files of package.json but I'm not sure if we can/should rely on it (in particular, I don't think pnpm changeset publish would respect it but I haven't tried).

@alcuadrado
Copy link
Member

alcuadrado commented Dec 3, 2024

I think the approach makes sense. Wanna review it, @schaable ?

@alcuadrado alcuadrado requested a review from schaable December 3, 2024 22:01
schaable
schaable approved these changes Dec 3, 2024
View reviewed changes
Copy link
Member

@schaable schaable left a comment

Choose a reason for hiding this comment

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

Makes sense and it's well documented. LGTM!

@galargh galargh added this pull request to the merge queue Dec 4, 2024
Merged via the queue into v-next with commit 7f07720 Dec 4, 2024
44 checks passed
@galargh galargh deleted the init-gitignore branch December 4, 2024 10:52
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 5, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@schaable schaable schaable approved these changes

@kanej kanej Awaiting requested review from kanej

Assignees

No one assigned

Labels

None yet

Projects

Hardhat
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@galargh @alcuadrado @schaable