Updating publishing guide and set markdown formatter#14553
Merged
Conversation
Contributor
|
I can reproduce that running |
Fix template so that they create READMEs that follow the formatting rules. Disabled the following rules: - MD032: Don't require blank lines around lists (needed for the template to work) - MD033: allow inline html (is used often across the READMEs - MD041: don't require h1 in first line (handled via html in most READMEs) Also added the config to the `.theis/settings.json`.
jfaltermeier
reviewed
Dec 2, 2024
Contributor
jfaltermeier
left a comment
jfaltermeier
left a comment
There was a problem hiding this comment.
I only have one more comment, then it looks good to me.
jfaltermeier
approved these changes
Dec 2, 2024
Also add instructions to setup npm token. Some minor formatting improvements. Signed-off-by: Simon Graband <sgraband@eclipsesource.com>
Contributor
Author
|
@jfaltermeier Could you take another look at the slight adjustments i added in the last commit? It includes better descriptions for patch releases. TIA |
jfaltermeier
reviewed
Dec 9, 2024
Signed-off-by: Simon Graband <sgraband@eclipsesource.com>
jfaltermeier
approved these changes
Dec 10, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What it does
This PR updates the publishing guide to reflect the current state and my learnings from the last releases.
When working with the publishing guide (and the changelog for that matter) i noticed that saving always produced changes on my end.
Therefore i went ahead and added a markdownlinter extension and set it as the formatter (and formatted all files).
If this is unwanted, or we want another solution, let me know, i will gladly look into it.
However, with the current state i am not quite sure, why we do not get a lot of formatting changes from different setups that developers have with their markdown formatter configuration.
How to test
Follow-ups
Breaking changes
Attribution
Review checklist
Reminder for reviewers