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

Make the tool package nicer #792

Merged
merged 4 commits into from
Jun 15, 2021
Merged

Conversation

baronfel
Copy link
Contributor

@baronfel baronfel commented Jun 13, 2021

This adds

  • license link
  • package type
  • better description
  • release notes
  • icon
  • readme

to the generated package.

Found a paket bug so the readme part doesn't work, but it also doesn't break anything so we can add it now and be ready for when paket updates. I logged the paket issue, submitted a fix, and verified that fix with this repo so it should be all fine.

EDIT: updated paket with the fix and all is good now.

@baronfel
Copy link
Contributor Author

Here's the new generated nuspec after this:

<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
  <metadata>
    <id>fsautocomplete</id>
    <version>0.46.2</version>
    <title>FsAutoComplete</title>
    <authors>FsAutoComplete contributors</authors>
    <requireLicenseAcceptance>false</requireLicenseAcceptance>
    <license type="expression">Apache-2.0</license>
    <licenseUrl>https://licenses.nuget.org/Apache-2.0</licenseUrl>
    <icon>logo.png</icon>
    <description>A community-developed Language Server Protocol implementation for F#</description>
    <releaseNotes>BUGFIX: fix the dotnet tool packaging to include a missing dependency for code formatting
BUGFIX: [fix indentation and insert position for unopened namespaces](https://github.com/fsharp/FsAutoComplete/pull/788) (Thanks @Booksbaum)
ENHANCEMENT: [Render parameters that are functions with parens for readability](https://github.com/fsharp/FsAutoComplete/pull/785)</releaseNotes>
    <readme>README.md</readme>
    <packageTypes>
      <packageType name="DotnetTool" />
    </packageTypes>
    <repository type="git" url="https://github.com/baronfel/fsautocomplete" commit="9bd0ea012588f41eec47390b79f6d654abf7af15" />
    <contentFiles>
      <files include="any/net5.0/default.win32manifest" buildAction="Content" />
    </contentFiles>
  </metadata>
</package>

which looks quite nice as a base to me. the logo and readme are added to the package root.

@baronfel baronfel merged commit 033be20 into ionide:master Jun 15, 2021
@baronfel baronfel deleted the improve-packaging branch June 15, 2021 21:39
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.

1 participant