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.

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

Error: Make sure to edit the README.md file before you publish your extension. #175292

Closed
chris-miner opened this issue Feb 23, 2023 · 2 comments
Closed

Error: Make sure to edit the README.md file before you publish your extension. #175292

chris-miner opened this issue Feb 23, 2023 · 2 comments
Assignees
@ulugbekna

Comments

@chris-miner
Copy link

chris-miner commented Feb 23, 2023 •
edited
Loading

Does this issue occur when all extensions are disabled?: Yes

  • VS Code Version: not relevant
  • OS Version: not relevant

Steps to Reproduce:

  1. Create an extension
  2. install vsce (npm install -g @vscode/vsce)
  3. run vsce package at the command line
  4. notice error => ERROR Make sure to edit the README.md file before you package or publish your extension.
  5. edit README.md
  6. run vsce package again

found:
the same error is produced

expected:
the error would not be produced.

extra info:
I'm just trying to create a local package of my extension for use on my local machine in my local development environment. I'd rather not guess what vsce needs to see in my README.md before it will not announce errors. This seems related to #14730

workaround:
Deleting the contents of my README.md remedied the error message. I now have a completely empty README.md file. The vsce tool has no issues with that.
@ulugbekna
Copy link
Contributor

I faced the same problem today. Would this message be more helpful: "It seems the README.md still contains template text. Make sure to edit the README.md file before you package or publish your extension." ?

@ulugbekna ulugbekna assigned ulugbekna and unassigned sandy081 Feb 23, 2023
@chris-miner
Copy link
Author

chris-miner commented Feb 24, 2023 •
edited
Loading

Or perhaps leave it as a warning rather than an error. I can see that if I was actually publishing it I would want to not publish boiler-plate. Or maybe don't provide the boiler-plate. I don't really see any good solutions to the issue. However, If the complaint expressed in the error is that the README.md was not edited, and the README.md was edited, then the 'error' doesn't make a lot of sense. I also don't think that an empty README.md makes a lot of sense either.

ulugbekna added a commit to microsoft/vscode-vsce that referenced this issue Feb 24, 2023
@ulugbekna
Merge pull request #844 from microsoft/ulugbekna/improve-err-msg-read…
7d1cc98 
…me-edit

fix microsoft/vscode#175292
@github-actions github-actions bot locked and limited conversation to collaborators Apr 10, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@ulugbekna ulugbekna

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@sandy081 @ulugbekna @chris-miner