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

docs(website): add instructions for installing from WinGet #520

Merged
merged 6 commits into from
Feb 29, 2024

Conversation

lloydjatkinson
Copy link
Contributor

Description

This PR adds WinGet installation instructions.

Motivation and Context

Relating to #351 git-cliff was added to the official WinGet packages list via microsoft/winget-pkgs#140905

How Has This Been Tested?

Running winget install git-cliff on Windows.

Screenshots / Logs (if applicable)

Types of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (no code change)
  • Refactor (refactoring production code)
  • Other

Checklist:

  • My code follows the code style of this project.
  • I have updated the documentation accordingly.
  • I have formatted the code with rustfmt.
  • I checked the lints with clippy.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Copy link

welcome bot commented Feb 27, 2024

Thanks for opening this pull request! Please check out our contributing guidelines! ⛰️

@lloydjatkinson lloydjatkinson mentioned this pull request Feb 27, 2024
@codecov-commenter
Copy link

codecov-commenter commented Feb 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 41.30%. Comparing base (4508d4d) to head (8cc5be0).
Report is 2 commits behind head on main.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #520   +/-   ##
=======================================
  Coverage   41.30%   41.30%           
=======================================
  Files          15       15           
  Lines        1034     1034           
=======================================
  Hits          427      427           
  Misses        607      607           
Flag Coverage Δ
unit-tests 41.30% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Owner

@orhun orhun left a comment

Choose a reason for hiding this comment

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

Thanks for this!

---
sidebar_position: 8
---
# Windows
Copy link
Owner

Choose a reason for hiding this comment

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

Maybe it would be better to rename this file/title to "WinGet" instead for being more specific, what do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Possibly! Or windows.md, with a section for WinGet, then any other sections in the future? Up to you of course

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thinking about it more, you're right, winget.md would be better!

website/docs/installation/windows.md Outdated Show resolved Hide resolved
@lloydjatkinson
Copy link
Contributor Author

Probably best to squash this because of all the typo commits...

Copy link
Owner

@orhun orhun left a comment

Choose a reason for hiding this comment

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

Thanks!

@orhun orhun merged commit eeaa406 into orhun:main Feb 29, 2024
42 checks passed
Copy link

welcome bot commented Feb 29, 2024

Congrats on merging your first pull request! ⛰️

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