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

File called README.md is always included #978

Open
OscarAblinger opened this issue May 13, 2024 · 1 comment
Open

File called README.md is always included #978

OscarAblinger opened this issue May 13, 2024 · 1 comment
Labels
bug Issue identified by VS Code Team member as probable bug help wanted Issues identified as good community contribution opportunities

Comments

@OscarAblinger
Copy link

OscarAblinger commented May 13, 2024

We are developing an extension in a private repository. Naturally we have a README file that explains how to build it etc.. Not really useful as the front page for the extension, so instead we have a separate one for that.

When packaging it, I noticed that the README.md file is always included in the resulting .vsix file, even though I explicitely excluded it in the .vscodeignore file:

*
*/**
# also tried it explicitely
README.md

This is the case even when the readme is specified with --readme-path.

I found that this behaviour was introduced in PR #556.
While it was clearly intentionally added, I feel like this behaviour should definitely be considered a bug. If I ignore something, it should be ignored.
If I need the readme file, then I should have to include it in the specified files (or in this case not ignore it).

@benibenj benibenj added bug Issue identified by VS Code Team member as probable bug help wanted Issues identified as good community contribution opportunities labels May 13, 2024
@benibenj
Copy link
Contributor

You are right, at least when --readme-path is specified, the readme.md file should be able to be ignored.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issue identified by VS Code Team member as probable bug help wanted Issues identified as good community contribution opportunities
Projects
None yet
Development

No branches or pull requests

2 participants