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

feat: add readme path override #722

Closed
wants to merge 1 commit into from
Closed

feat: add readme path override #722

wants to merge 1 commit into from

Conversation

barnuri
Copy link

@barnuri barnuri commented Apr 24, 2022

need the support of use different readme file when you pack\publish an extension
i saw that there was an issue that close because it was out of scope, and i need it because my readme contains svgs, and it was very easy to add this support
#210

@ghost
Copy link

ghost commented Apr 24, 2022

CLA assistant check
All CLA requirements met.

@barnuri barnuri changed the title add readme path override feat: add readme path override Apr 24, 2022
@joaomoreno
Copy link
Member

and i need it because my readme contains svgs

Why exactly does the need for SVG warrant supporting different locations for README.md?

This is definitely out of scope, since changes would need to happen across the board: the Markteplace itself as well as VS Code, not just vsce.

@barnuri
Copy link
Author

barnuri commented Apr 24, 2022

and i need it because my readme contains svgs

Why exactly does the need for SVG warrant supporting different locations for README.md?

This is definitely out of scope, since changes would need to happen across the board: the Markteplace itself as well as VS Code, not just vsce.

because I have in the readme file a github action badges, so i want to create the same readme without them and send him his path to packing/deploying process in vsce

because vsce deploying failed on include svg in readme

@barnuri
Copy link
Author

barnuri commented Apr 24, 2022

so in this way you can manage a readme file for vscode and readme file for git

@barnuri
Copy link
Author

barnuri commented Apr 24, 2022

i find that there was an issue that talk about it too that you add some domain to whitelist, in my git i use github relative links of badges to make it work also it the forks of the main repo

#240

@joaomoreno
Copy link
Member

joaomoreno commented Apr 25, 2022

What domain do your svg icons come from?

Any chance you can use PNG or some other image format?

@barnuri
Copy link
Author

barnuri commented Apr 25, 2022

What domain do your svg icons come from?

Any chance you can use PNG or some other image format?

@joaomoreno

no like i said its a github actions bagdes, they give you an svg not an png
and i need them relative because i want them to work for any fork
why its a problem to add this feature to support different Readme file ?

[![.github/workflows/runTests.yaml](/../../actions/workflows/runTests.yaml/badge.svg)](/../../actions/workflows/runTests.yaml)
[![.github/workflows/publish.yaml](/../../actions/workflows/publish.yaml/badge.svg)](/../../actions/workflows/publish.yaml)

@joaomoreno
Copy link
Member

It is incredibly error prone to use .. in those paths. Just use the full URL to them and you'll be fine and VSCE won't complain.

why its a problem to add this feature to support different Readme file ?

Because maybe it makes vsce happy, but VS Code won't know that your extension's README.md will be somewhere else. Also, the VS Marketplace won't be aware as well.

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.

2 participants