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.

Sign up for GitHub

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

Jump to bottom

docs: split out <3.x.x CHANGELOG.md for faster loading #13352

Merged
merged 2 commits into from
Jul 25, 2024
Merged

docs: split out <3.x.x CHANGELOG.md for faster loading #13352

merged 2 commits into from
Jul 25, 2024

Conversation

agilgur5
Copy link
Member

@agilgur5 agilgur5 commented Jul 16, 2024 •
edited
Loading

Fixes "Future Work" section of #13236

Motivation

  • the CHANGELOG.md is quite large and so can take some time to load as it's a giant file (>10k LoC)

Modifications

  • split the <3.x.x versions of the changelog into a separate CHANGELOG-2-x-x.md file
    • this is about a 50% decrease in size, 5k+ LoC split off
    • it is exceedingly rare that folks are still on 2.x.x
    • link the two changelogs together as well at the bottom and top, respectively
    • modify changelog script to skip <3.x.x
      • we could also modify it to make two files, but I don't think we need to at this time

Verification

Ran ./hack/changelog.sh > CHANGELOG.md and got no diff

@agilgur5
docs: split out <3.x.x CHANGELOG.md for faster loading
b2731b8 
- the `CHANGELOG.md` is quite large and so can take some time to load as it's a giant file (>10k LoC)
  - split the <3.x.x versions of the changelog into a separate `CHANGELOG-2-x-x.md` file
    - this is about a 50% decrease in size, 5k+ LoC split off
    - it is exceedingly rare that folks are still on 2.x.x
    - link the two changelogs together as well at the bottom and top, respectively
    - modify changelog script to skip <3.x.x
      - we could also modify it to make two files, but I don't think we need to at this time

Signed-off-by: Anton Gilgur <[email protected]>
@agilgur5 agilgur5 added the area/docs Incorrect, missing, or mistakes in docs label Jul 16, 2024
@agilgur5 agilgur5 marked this pull request as ready for review July 16, 2024 01:27
@agilgur5 agilgur5 added the area/build Build or GithubAction/CI issues label Jul 16, 2024
Joibel
Joibel approved these changes Jul 25, 2024
View reviewed changes
Copy link
Member

@Joibel Joibel left a comment

Choose a reason for hiding this comment

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

LGTM

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jul 25, 2024
@Joibel Joibel merged commit 709d0d0 into argoproj:main Jul 25, 2024
18 checks passed
@agilgur5 agilgur5 deleted the docs-split-changelog branch July 25, 2024 13:28
@agilgur5 agilgur5 mentioned this pull request Jul 30, 2024
Merged
@agilgur5 agilgur5 added this to the v3.5.x patches milestone Jul 30, 2024
agilgur5 added a commit that referenced this pull request Jul 30, 2024
@agilgur5
docs: split out <3.x.x CHANGELOG.md for faster loading (#13352)
0bcbe88 
Signed-off-by: Anton Gilgur <[email protected]>
(cherry picked from commit 709d0d0)
@agilgur5 agilgur5 mentioned this pull request Sep 21, 2024
Merged
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Joibel Joibel Joibel approved these changes

@terrytangyuan terrytangyuan Awaiting requested review from terrytangyuan

Assignees
No one assigned
Labels
area/build Build or GithubAction/CI issues area/docs Incorrect, missing, or mistakes in docs lgtm This PR has been approved by a maintainer
Projects
None yet
Milestone
v3.5.x patches
Development

Successfully merging this pull request may close these issues.
2 participants
@agilgur5 @Joibel