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

README: add Windows install instruction for Winget #304

Merged
merged 3 commits into from
Mar 15, 2024

Conversation

kbdharun
Copy link
Contributor

Changes

  • Add Windows Install instruction for Winget.

Recently, I added the manifest for soft-serve to Winget. Once new releases are made, I will update the Winget manifest asap. I have referred to glow README for this template.

@bashbunni
Copy link
Member

Related: goreleaser/goreleaser#2290

We will likely wait for goreleaser to support winget before updating our docs. I know they're planning on supporting this in the near future, so will keep this open for now as a reminder. That will allow us to ensure that the winget package is automatically updated with each release. Thanks for the nudge!

Copy link
Contributor Author

@kbdharun kbdharun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, seems like this PR is GTG. The automation has been added and the recent releases were created by it https://github.com/microsoft/winget-pkgs/pulls?q=is%3Apr+charmbracelet+is%3Aclosed+ .

I have updated the package identifier to reflect the new Moniker.

README.md Outdated
@@ -55,7 +55,7 @@ manager:
brew tap charmbracelet/tap && brew install charmbracelet/tap/soft-serve

## Windows (with Winget)
winget install charmbracelet.soft-serve
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, I know it's been a while. Thank you for this PR, I was just wondering if there's any particular reason why you removed the publisher portion of the package name in this commit? I know nothing about winget, so please don't take this as anything other than me trying to understand how the naming works 😂

Copy link
Contributor Author

@kbdharun kbdharun Dec 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, Winget supports installing applications via the full package identifier or a unique moniker (which is defined in the locale file). Moniker is a short or alternative name that can be used by an application for easy installation.

i.e. https://github.com/microsoft/winget-pkgs/blob/4d0fcf398afe265216966905f7e6aa3c0a6e3a41/manifests/c/charmbracelet/soft-serve/0.7.3/charmbracelet.soft-serve.locale.en-US.yaml#L12

So instead of specifying the full identifier with publisher i.e winget install charmbracelet.soft-serve you can use winget install soft-serve to install it with ease instead.

In case there is another application with the same name/moniker in future we could switch this back to the full package identifier, currently this would work fine.

@bashbunni
Copy link
Member

It looks like we're now using goreleaser to publish our releases, so I'm happy to merge this. I'm just a bit unsure about naming and want to make sure that the package naming is consistent with what gets published to the winget manifest.

Related: https://github.com/microsoft/winget-pkgs/blob/master/manifests/c/charmbracelet/soft-serve/0.7.3/charmbracelet.soft-serve.installer.yaml#L3C20-L3C34

@kbdharun kbdharun changed the title README: add Windows Install Instruction (Winget) README: add Windows Install Instruction for Winget Dec 12, 2023
README.md Outdated Show resolved Hide resolved
Co-authored-by: Ayman Bagabas <ayman.bagabas@gmail.com>
@kbdharun kbdharun changed the title README: add Windows Install Instruction for Winget README: add Windows install instruction for Winget Dec 12, 2023
@bashbunni bashbunni merged commit 87d61a3 into charmbracelet:main Mar 15, 2024
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.

3 participants