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

[cleanup] Add package description #2702

Merged
merged 2 commits into from
Nov 20, 2023
Merged

Conversation

dominikschulz
Copy link
Member

This commit adds package descriptions to the generated Deb and RPM packages to make them easier to discover and separate from other similar packages.

Fixes #2695

@dominikschulz dominikschulz added the release Release related label Nov 19, 2023
@dominikschulz dominikschulz added this to the 1.15.10 milestone Nov 19, 2023
@dominikschulz dominikschulz self-assigned this Nov 19, 2023
@fetwar
Copy link
Contributor

fetwar commented Nov 19, 2023

This PR looks good, the only thing I worry about is the difference between short and long descriptions, I can't really seem to find how goreleaser handles the two and I think the short description should be the primary goal to update. Viewing the long description often requires a flag like apt search's --full option.

I couldn't find much documentation around specifying two different descriptions, but looking at short descriptions vs long in issue #2695 it seems to be that at least apt just truncates after the top line.

Do you think it may be best to write the descriptions so that the top line is suitable for a short summary and the remainder is suitable for long summary?

The slightly more awesome standard unix password manager for teams.

... rest of your long description.

Another option would be to rewrite a short description for the packages, but I think the current description on github is great.

Maybe something like this for gopass

gopass password manager - full featured CLI replacement for pass, designed for teams.

... rest of your long description.

AnomalRoil
AnomalRoil previously approved these changes Nov 20, 2023
Copy link
Member

@AnomalRoil AnomalRoil left a comment

Choose a reason for hiding this comment

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

LGTM

This commit adds package descriptions to the generated Deb and RPM
packages to make them easier to discover and separate from other
similar packages.

Fixes gopasspw#2695

Signed-off-by: Dominik Schulz <[email protected]>
Signed-off-by: Dominik Schulz <[email protected]>
@dominikschulz
Copy link
Member Author

@fetwar Thank you, fixed.

@dominikschulz dominikschulz merged commit 875cdb9 into gopasspw:master Nov 20, 2023
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release Release related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

apt packages - no description given
3 participants