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

v2 CHANGELOG.rst fails to render on github.com #7150

Closed
willhughes-au opened this issue Aug 1, 2022 · 5 comments
Closed

v2 CHANGELOG.rst fails to render on github.com #7150

willhughes-au opened this issue Aug 1, 2022 · 5 comments
Labels
bug This issue is a bug. p3 This is a minor priority issue

Comments

@willhughes-au
Copy link

Describe the bug

When accessing the AWS CLI v2 CHANGELOG.rst - Github fails to render the page.
I believe this is because the file has grown over some limits from github.

Expected Behavior

https://github.com/aws/aws-cli/blob/v2/CHANGELOG.rst should render correctly.

Current Behavior

Returns a Github Unicorn error after some period of time.

This page is taking too long to load.

Sorry about that. Please try refreshing and contact us if the problem persists.

Reproduction Steps

Try to navigate to CHANGELOG.rst on Github. Direct link or the file browser (when v2 branch selected).

Possible Solution

Trim the file - move older entries to another file.

Additional Information/Context

No response

CLI version used

n/a

Environment details (OS name and version, etc.)

Browser

@willhughes-au willhughes-au added bug This issue is a bug. needs-triage This issue or PR still needs to be triaged. labels Aug 1, 2022
@willhughes-au
Copy link
Author

Sorry if this isn't the right way to report a bug with the repo itself.

@tim-finnigan
Copy link
Contributor

Thanks @willhughes-au for creating the issue. It's something that occurred recently since the CHANGELOG.rst exceeded a certain size. The team is aware of this and currently looking into solutions for addressing it.

@tim-finnigan tim-finnigan removed the needs-triage This issue or PR still needs to be triaged. label Aug 1, 2022
@tim-finnigan
Copy link
Contributor

tim-finnigan commented Aug 1, 2022

As a temporary workaround, you could either add "?plain=1" to the end like this: https://github.com/aws/aws-cli/blob/v2/CHANGELOG.rst?plain=1 or use this link to the raw file: https://raw.githubusercontent.com/aws/aws-cli/v2/CHANGELOG.rst.

@nateprewitt
Copy link
Member

This should be resolved as of today's release of the CLI v2 (2.16.6). The CHANGELOG.rst for v2 now only contains entries for CLI v2.0.0 and later, this reduced the size of the file by ~50%. If you still need access to CLI v1 changelog information, it's still available here.

Copy link

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 bug. p3 This is a minor priority issue
Projects
None yet
Development

No branches or pull requests

3 participants