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

fix(metadata): allow long summaries in output #1759

Merged
merged 1 commit into from
Jul 24, 2024
Merged

fix(metadata): allow long summaries in output #1759

merged 1 commit into from
Jul 24, 2024

Conversation

lengau
Copy link
Collaborator

@lengau lengau commented Jul 24, 2024

Fixes #1758

More context in #1568

@lengau lengau requested a review from a team July 24, 2024 12:10
@tigarmo tigarmo requested a review from a team July 24, 2024 12:12
Copy link
Contributor

@mr-cal mr-cal left a comment

Choose a reason for hiding this comment

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

I had forgotten charmcraft is grandfathered into unlimited-length summaries. Do you plan to deprecate that in a future major release? Or leave it as-is?

@lengau
Copy link
Collaborator Author

lengau commented Jul 24, 2024

@mr-cal on input we limit the summary string to 200 characters (

class CharmcraftSummaryStr(models.SummaryStr):
"""A brief summary of this charm or bundle. Ideally, this should fit into one line."""
# Maximum length was set to 200 characters because the 78 character maximum
# inherited from craft-application is too restrictive, as several hundred charms
# already exceed this maximum.
# Eventually this limit will be reduced, ideally to 78 characters, though that may
# never happen entirely. Reductions will only occur on major releases.
# https://github.com/canonical/charmcraft/issues/1598
max_length = 200
), but since this is the output I'm not particularly concerned about checking it (and having another potential failure point) there.

There's no current plan to reduce it further, as charmhub has quite a few that are longer.

@lengau lengau merged commit 83c1621 into main Jul 24, 2024
16 of 17 checks passed
@lengau lengau deleted the work/1758 branch July 24, 2024 15:04
@mr-cal
Copy link
Contributor

mr-cal commented Jul 24, 2024

@mr-cal on input we limit the summary string to 200 characters (

class CharmcraftSummaryStr(models.SummaryStr):
"""A brief summary of this charm or bundle. Ideally, this should fit into one line."""
# Maximum length was set to 200 characters because the 78 character maximum
# inherited from craft-application is too restrictive, as several hundred charms
# already exceed this maximum.
# Eventually this limit will be reduced, ideally to 78 characters, though that may
# never happen entirely. Reductions will only occur on major releases.
# https://github.com/canonical/charmcraft/issues/1598
max_length = 200

), but since this is the output I'm not particularly concerned about checking it (and having another potential failure point) there.

There's no current plan to reduce it further, as charmhub has quite a few that are longer.

Ah, it's 200. Leaving it as-is is fine with me!

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.

Max summary length is limited in metadata output
3 participants