CHANGELOG.v2.md file getting too big to view on GitHub

aws / aws-cdk

The AWS Cloud Development Kit is a framework for defining cloud infrastructure in code

https://aws.amazon.com/cdk

Apache License 2.0

11.66k stars 3.92k forks source link

CHANGELOG.v2.md file getting too big to view on GitHub #25550

Open jrobbins-LiveData opened 1 year ago

jrobbins-LiveData commented 1 year ago

Describe the bug

Expected Behavior

Expect to be able to view the formatted markdown content.

Current Behavior

GitHub says "This blob took too long to generate."

Reproduction Steps

Click on this link.

Possible Solution

Maybe prune the file of older version info, or split it into multiple parts.

Additional Information/Context

No response

CDK CLI Version

2.79.1 (build 2e7f8b7)

Framework Version

No response

Node.js Version

v18.13.0

OS

Windows 10

Language

Python

Language Version

Python 3.9.13

Other information

No response

peterwoodworth commented 1 year ago

Relevant comment for the same issue for the v1 changelog

This is a rendering limitation on GitHub's end and since V1 is in maintenance mode this likely won't get prioritized. The workaround is to view the raw file from the link on that page. The V2 changelog is rendering and when it starts to approach the size threshold then the team may consider alternative approaches.

Since this is the v2 changelog, it seems it is time we start considering alternate approaches. For now, viewing the raw file or going through our releases should suffice as a workaround.

tim-finnigan commented 1 year ago

For visibility I'll link the raw/plain text versions of the CHANGELOG which should load and serve as a workaround for now:

Raw file: https://raw.githubusercontent.com/aws/aws-cdk/main/CHANGELOG.v2.md
Plain text: https://github.com/aws/aws-cdk/blob/main/CHANGELOG.v2.md?plain=1

ashishdhingra commented 5 months ago

As an alternative, CDK release pipeline could be modified to create changelog per month.