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.txt is too big – move old changelog items to separate changelog.txt #18126

Closed
tobifjellner opened this issue Oct 28, 2019 · 7 comments · Fixed by #19761
Closed

Readme.txt is too big – move old changelog items to separate changelog.txt #18126

tobifjellner opened this issue Oct 28, 2019 · 7 comments · Fixed by #19761
Assignees
Labels
[Status] In Progress Tracking issues with work in progress [Type] Build Tooling Issues or PRs related to build tooling

Comments

@tobifjellner
Copy link
Contributor

Describe the bug
Readme.txt for version 6.7.0 is 15 kbytes.
The readme parser may have problems handling files larger than 10 kbytes. Easiest fix is to migrate older items in the changelog to a separate changelog.txt.
A positive side-effect of this is that the number of readme strings in the translation project will be less.

@swissspidy
Copy link
Member

Where do you see that?

http://plugins.svn.wordpress.org/gutenberg/trunk/readme.txt only contains 1 changelog entry. So does http://plugins.svn.wordpress.org/gutenberg/tags/6.7.0/readme.txt.

@swissspidy swissspidy added [Status] Needs More Info Follow-up required in order to be actionable. [Type] Build Tooling Issues or PRs related to build tooling labels Oct 28, 2019
@tobifjellner
Copy link
Contributor Author

I didn't actually read the readme. I just noted that its size is about 15 kb and know that some plugins have had issues with too big readme and it's been said that 10 kb should be regarded as the limit.
Anyway, if it still doesn't break things, then I guess it would not be high prio to "fix" this :)

@swissspidy swissspidy added the Needs Technical Feedback Needs testing from a developer perspective. label Oct 28, 2019
@swissspidy
Copy link
Member

It's indeed quite large even with only listing the most recent changelog.

I know some plugins remove the changelog entirely and just point to changelog.txt or the changelog on the GitHub release page.

We could do that here too. A quick test shows that it would reduce the size from almost 16KB to around 7KB.

@youknowriad
Copy link
Contributor

@swissspidy I'd love more thoughts on the subject, but that seems reasonable to me, we would have to tweak the release tool a little bit for the change, but it should be minor.

@youknowriad youknowriad removed Needs Technical Feedback Needs testing from a developer perspective. [Status] Needs More Info Follow-up required in order to be actionable. labels Nov 19, 2019
@youknowriad
Copy link
Contributor

These files have been moved to the Git repository (cc @jorgefilipecosta), implementing this will be easier now.

@jorgefilipecosta
Copy link
Member

jorgefilipecosta commented Jan 14, 2020

Hi @youknowriad, it seems currently we only keep the changelog of the last version, but even the changelog for one version is huge.
There are some options we can follow:

  • Force the person doing the release to provide a smaller changelog with a character limit.
  • Parse the changelog and only include some sections e.g: the new features part.
  • Or the option @swissspidy referred of just linking to the changelog.

Which option would you prefer?

@youknowriad
Copy link
Contributor

I'd just go with the linking personally as well

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Status] In Progress Tracking issues with work in progress [Type] Build Tooling Issues or PRs related to build tooling
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants