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

Package Properties tab should expose the new Readme property #6457

Closed
advay26-zz opened this issue Jul 31, 2020 · 4 comments · Fixed by #7440
Closed

Package Properties tab should expose the new Readme property #6457

advay26-zz opened this issue Jul 31, 2020 · 4 comments · Fixed by #7440
Assignees
Labels
Feature-NuGet NuGet integration including pushing it properties, project and package references, and Pack support. Feature-Project-Properties-Designer The new project property pages which replace the legacy AppDesigner Resolution-Fixed The bug has been fixed, refer to the milestone to see in which release it was fixed. Triage-Investigate Reviewed and investigation needed by dev team
Milestone

Comments

@advay26-zz
Copy link

advay26-zz commented Jul 31, 2020

Similar to #4905, Embedded Readmes are being introduced and will be included in packages - Embedding and displaying NuGet READMEs.

The behavior for Project Properties would be similar to Icon and License File support:

  • Using a file picker, users can select a markdown file on disc (.md)

  • On selection, the value updates to the file's relative path

  • The project file is updated as below:

    <PropertyGroup>
        ...
        <PackageReadmeFile>readme.md</PackageReadmeFile>
        ...
    </PropertyGroup>

    <ItemGroup>
        ...
        <None Include="..\assets\readme.md" Pack="true" PackagePath=""/>
        ...
    </ItemGroup>

The UI view:

image

@drewnoakes drewnoakes added the Feature-Legacy-Application-Designer The "Application Designer" otherwise known as the legacy project properties label Jul 31, 2020
@jjmew jjmew added this to the Backlog milestone Aug 6, 2020
@jjmew jjmew added the Triage-Investigate Reviewed and investigation needed by dev team label Aug 6, 2020
@drewnoakes
Copy link
Member

We will likely add support for editor metadata here that sets the FileOpenDialog default extension to .md, as required in the spec.

@drewnoakes
Copy link
Member

There is some complexity here, in that the interceptor will need to create/update/remove the None item, in addition to the property itself.

@drewnoakes
Copy link
Member

drewnoakes commented Apr 13, 2021

There is some complexity here, in that the interceptor will need to create/update/remove the None item, in addition to the property itself.

That complexity also exists for PackageIcon which is not currently wired up to manage the project item. This works in the legacy pages. We need to handle this.

The mechanism should be similar between PackageIcon and PackageReadmeFile, so we should solve both at the same time. It's likely we can create reuse some code here too. ApplicationIcon (#7167) is likely similar as well.

<!-- TODO (tomescht):
We should re-think this. This property is the relative path to the icon file _within the package_; setting it does not guarantee
that the corresponding file in the project is correctly copied into the package. A better alternative may be to expose a property
with the path to the file in the project instead, and update this one appropriately when that one changes.
-->
<StringProperty Name="PackageIcon"
DisplayName="Icon file"
Description="The relative path from the package root to the icon file. In addition to setting this property you need to make sure that the file is included in the package. Image file size is limited to 1 MB. Supported file formats include JPEG and PNG. An image resolution of 128x128 is recommended."
HelpUrl="https://go.microsoft.com/fwlink/?linkid=2147134"
Category="General" />

@aortiz-msft aortiz-msft added the Feature-NuGet NuGet integration including pushing it properties, project and package references, and Pack support. label Jul 15, 2021
@MiYanni MiYanni assigned MiYanni and unassigned melytc Jul 28, 2021
@MiYanni MiYanni added Feature-Project-Properties-Designer The new project property pages which replace the legacy AppDesigner and removed Feature-Legacy-Application-Designer The "Application Designer" otherwise known as the legacy project properties labels Jul 28, 2021
@MiYanni
Copy link
Member

MiYanni commented Jul 28, 2021

I'll be implementing this into the new property pages.

@drewnoakes drewnoakes modified the milestones: Backlog, 17.0 Jul 28, 2021
@ghost ghost added the Resolution-Fixed The bug has been fixed, refer to the milestone to see in which release it was fixed. label Jul 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature-NuGet NuGet integration including pushing it properties, project and package references, and Pack support. Feature-Project-Properties-Designer The new project property pages which replace the legacy AppDesigner Resolution-Fixed The bug has been fixed, refer to the milestone to see in which release it was fixed. Triage-Investigate Reviewed and investigation needed by dev team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants