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

[docs-only] add toc to changelog #11355

Merged
merged 2 commits into from
Nov 9, 2023
Merged

[docs-only] add toc to changelog #11355

merged 2 commits into from
Nov 9, 2023

Conversation

mmattel
Copy link
Contributor

@mmattel mmattel commented Nov 9, 2023

Description

Adds table of contents to the top of the CHANGELOG.md file.

Anchor links in markdown are generated from the content of the header according to the following rules:

  1. All text is converted to lowercase.
  2. All non-word text (e.g., punctuation, HTML) is removed.
  3. All spaces are converted to hyphens.
  4. Two or more hyphens in a row are converted to one.
  5. If a header with the same ID has already been generated, a unique incrementing number is appended, starting at 1.
  6. All changelogs for 2.x and below have a main entrance link

Related Issue

changelog/CHANGELOG.tmpl Outdated Show resolved Hide resolved
@michaelstingl
Copy link
Contributor

@mmattel could you post the desktop TOC to get an idea?

changelog/CHANGELOG.tmpl Outdated Show resolved Hide resolved
changelog/CHANGELOG.tmpl Outdated Show resolved Hide resolved
@mmattel
Copy link
Contributor Author

mmattel commented Nov 9, 2023

Run locally, works nicely 😄
image

@mmattel mmattel enabled auto-merge (squash) November 9, 2023 15:44
@fmoc
Copy link
Contributor

fmoc commented Nov 9, 2023

Will need to test this locally.

changelog/CHANGELOG.tmpl Show resolved Hide resolved
changelog/CHANGELOG.tmpl Show resolved Hide resolved
Copy link
Contributor

@fmoc fmoc left a comment

Choose a reason for hiding this comment

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

See above.

Copy link

sonarqubecloud bot commented Nov 9, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@mmattel
Copy link
Contributor Author

mmattel commented Nov 9, 2023

Also include the earlier versions or how to run locally...

owncloud/ios-app#1287 (comment)

@mmattel mmattel merged commit 879a54c into master Nov 9, 2023
7 checks passed
@delete-merged-branch delete-merged-branch bot deleted the mmattel-patch-1 branch November 9, 2023 17:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants