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

Explicitly exclude DS store files #492

Merged
merged 1 commit into from Jun 4, 2020
Merged

Conversation

thboop
Copy link
Collaborator

@thboop thboop commented Jun 4, 2020

Related to this npm issue:
npm/cli#440 (comment)

We published a release of @actions/github that included a DS_STORE file. It appears that the default .npmignore is overwritten by the files list. So we can add !.DS_Store to this list to ensure we don't publish any more DS_STORE files.

Tested locally using npm publish --dry-run and npm pack --dry-run
Resolves #491

Copy link
Contributor

@konradpabjan konradpabjan left a comment

Choose a reason for hiding this comment

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

Looks good to me!

I briefly thought about explicitly specifying the file types (something like this)

lib/*.js
lib/*.js.map
lib/*.d.ts

This would prevent other types of files types from showing up accidentally (not just .DS_Store). But I don't think this is necessary. Thoughts?

@thboop
Copy link
Collaborator Author

thboop commented Jun 4, 2020

Looks good to me!

I briefly thought about explicitly specifying the file types (something like this)

lib/*.js
lib/*.js.map
lib/*.d.ts

This would prevent other types of files types from showing up accidentally (not just .DS_Store). But I don't think this is necessary. Thoughts?

There are some other file types automatically ignored that could also get added. We could prevent those by explicitly stating the file types we support, but looking through that list nothing really sticks out to me as something that we would accidentally include.

Hopefully this is just a short term fix until an npm bugfix is in, so I think we can avoid specifying explicit file types for now.

@konradpabjan
Copy link
Contributor

Hopefully this is just a short term fix until an npm bugfix is in, so I think we can avoid specifying explicit file types for now.

Agree, the chances of other types of files accidentally showing up is pretty small so this is fine. Once the upstream issue is fixed, we can get rid of this.

Ship it! 🚀

@thboop thboop merged commit 3e40dd3 into master Jun 4, 2020
@thboop thboop deleted the users/thboop/ignoreDSStore branch June 4, 2020 19:14
at-wat pushed a commit to at-wat/actions-toolkit that referenced this pull request Aug 31, 2023
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.

.DS_Store in @actions/github 3.0.0
2 participants