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

Changelog is too big and cannot be opened in Github #3938

Closed
yogevyuval opened this issue Nov 20, 2023 · 2 comments
Closed

Changelog is too big and cannot be opened in Github #3938

yogevyuval opened this issue Nov 20, 2023 · 2 comments
Labels
bug This issue is a confirmed bug. p3 This is a minor priority issue

Comments

@yogevyuval
Copy link

Describe the issue

The Changelog has become so long, that sometimes github just failes in presenting it. It would be best to split into historical changelog and new one to make it usable again.

Links

https://github.com/boto/boto3/blob/develop/CHANGELOG.rst

@yogevyuval yogevyuval added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Nov 20, 2023
@tim-finnigan tim-finnigan self-assigned this Nov 20, 2023
@tim-finnigan
Copy link
Contributor

tim-finnigan commented Nov 20, 2023

Hi @yogevyuval thanks for reporting this. We also received the same issue for the AWS CLI: aws/aws-cli#7150

As mentioned there, you could use the following links as workarounds:

We had reached out to GitHub about this issue: https://github.com/orgs/community/discussions/28239. At one point we observed that the the raw file would be displayed by default for large files, but that no longer seems to be the case.

It seems like https://github.com/boto/boto3/blob/develop/CHANGELOG.rst will sometimes load fine and other times show an error page. It probably depends on GitHub's traffic and your network connection. Ideally GitHub could provide a better solution for this scenario, as other repositories are affected as well.

The team could consider splitting up the CHANGELOG file as well, but given that using the https://raw... URL or appending ?plain=1 works fine (and that GitHub may adjust their loading behavior in the future), I think this is a lower priority issue.

@tim-finnigan tim-finnigan removed their assignment Nov 20, 2023
@tim-finnigan tim-finnigan added bug This issue is a confirmed bug. p3 This is a minor priority issue and removed documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Nov 20, 2023
Copy link

github-actions bot commented Mar 8, 2024

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue is a confirmed bug. p3 This is a minor priority issue
Projects
None yet
Development

No branches or pull requests

2 participants