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

Add .github/ to .npmignore #747

Merged
merged 1 commit into from Jun 4, 2023
Merged

Add .github/ to .npmignore #747

merged 1 commit into from Jun 4, 2023

Conversation

ericcornelissen
Copy link
Contributor

Just a minor suggestion to omit some unnecessary files from the published package.

On a related note, I'd suggest switching from a blocklist to an allowlist approach. What I mean is to write .npmignore such that you list files that should be published instead of files that shouldn't. The main advantage of this approach would be that it avoids publishing files unintentionally (most importantly files that aren't VCS tracked), but comes at the cost of having to be updated if new files should be included in the package. In my personal experience this trade-off is worth it.

The following allowlist .npmignore would work for this project (note that package.json is always published):

# Ignore everything ...
/*

# Except what needs to be published
!lib/
!CHANGELOG.md
!LICENSE
!README*.md # Covers README.md and README-es.md as well as any other languages added in the future
!config.d.ts
!config.js

@motdotla motdotla mentioned this pull request Jun 4, 2023
@motdotla motdotla merged commit 4443c59 into motdotla:master Jun 4, 2023
5 checks passed
@motdotla
Copy link
Owner

motdotla commented Jun 4, 2023

Thank you for catching this. 100% agree. I will switch to an allowlist soon.

@motdotla
Copy link
Owner

motdotla commented Jun 4, 2023

Published as v16.1.4

@ericcornelissen ericcornelissen deleted the patch-1 branch June 4, 2023 16:14
Vylpes pushed a commit to Vylpes/Droplet that referenced this pull request Dec 25, 2023
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [dotenv](https://github.com/motdotla/dotenv) | dependencies | minor | [`16.0.3` -> `16.3.1`](https://renovatebot.com/diffs/npm/dotenv/16.0.3/16.3.1) |

---

### Release Notes

<details>
<summary>motdotla/dotenv (dotenv)</summary>

### [`v16.3.1`](https://github.com/motdotla/dotenv/blob/HEAD/CHANGELOG.md#1631-2023-06-17)

[Compare Source](motdotla/dotenv@v16.3.0...v16.3.1)

##### Added

-   Add missing type definitions for `processEnv` and `DOTENV_KEY` options. [#&#8203;756](motdotla/dotenv#756)

### [`v16.3.0`](https://github.com/motdotla/dotenv/blob/HEAD/CHANGELOG.md#1630-2023-06-16)

[Compare Source](motdotla/dotenv@v16.2.0...v16.3.0)

##### Added

-   Optionally pass `DOTENV_KEY` to options rather than relying on `process.env.DOTENV_KEY`. Defaults to `process.env.DOTENV_KEY` [#&#8203;754](motdotla/dotenv#754)

### [`v16.2.0`](https://github.com/motdotla/dotenv/blob/HEAD/CHANGELOG.md#1620-2023-06-15)

[Compare Source](motdotla/dotenv@v16.1.4...v16.2.0)

##### Added

-   Optionally write to your own target object rather than `process.env`. Defaults to `process.env`. [#&#8203;753](motdotla/dotenv#753)
-   Add import type URL to types file [#&#8203;751](motdotla/dotenv#751)

### [`v16.1.4`](https://github.com/motdotla/dotenv/blob/HEAD/CHANGELOG.md#1614-2023-06-04)

[Compare Source](motdotla/dotenv@v16.1.3...v16.1.4)

##### Added

-   Added `.github/` to `.npmignore` [#&#8203;747](motdotla/dotenv#747)

### [`v16.1.3`](https://github.com/motdotla/dotenv/blob/HEAD/CHANGELOG.md#1613-2023-05-31)

[Compare Source](motdotla/dotenv@v16.1.2...v16.1.3)

##### Removed

-   Removed `browser` keys for `path`, `os`, and `crypto` in package.json. These were set to false incorrectly as of 16.1. Instead, if using dotenv on the front-end make sure to include polyfills for `path`, `os`, and `crypto`. [node-polyfill-webpack-plugin](https://github.com/Richienb/node-polyfill-webpack-plugin) provides these.

### [`v16.1.2`](https://github.com/motdotla/dotenv/blob/HEAD/CHANGELOG.md#1612-2023-05-31)

[Compare Source](motdotla/dotenv@v16.1.1...v16.1.2)

##### Changed

-   Exposed private function `_configDotenv` as `configDotenv`. [#&#8203;744](motdotla/dotenv#744)

### [`v16.1.1`](https://github.com/motdotla/dotenv/blob/HEAD/CHANGELOG.md#1611-2023-05-30)

[Compare Source](motdotla/dotenv@v16.1.0...v16.1.1)

##### Added

-   Added type definition for `decrypt` function

##### Changed

-   Fixed `{crypto: false}` in `packageJson.browser`

### [`v16.1.0`](https://github.com/motdotla/dotenv/blob/HEAD/CHANGELOG.md#1610-2023-05-30)

[Compare Source](motdotla/dotenv@v16.0.3...v16.1.0)

##### Added

-   Add `populate` convenience method [#&#8203;733](motdotla/dotenv#733)
-   Accept URL as path option [#&#8203;720](motdotla/dotenv#720)
-   Add dotenv to `npm fund` command
-   Spanish language README [#&#8203;698](motdotla/dotenv#698)
-   Add `.env.vault` support. 🎉 ([#&#8203;730](motdotla/dotenv#730))

ℹ️ `.env.vault` extends the `.env` file format standard with a localized encrypted vault file. Package it securely with your production code deploys. It's cloud agnostic so that you can deploy your secrets anywhere – without [risky third-party integrations](https://techcrunch.com/2023/01/05/circleci-breach/). [read more](https://github.com/motdotla/dotenv#-deploying)

##### Changed

-   Fixed "cannot resolve 'fs'" error on tools like Replit [#&#8203;693](motdotla/dotenv#693)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjAiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIn0=-->

Reviewed-on: https://gitea.vylpes.xyz/RabbitLabs/Droplet/pulls/250
Reviewed-by: Vylpes <ethan@vylpes.com>
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.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.

None yet

2 participants