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

Migrate changelog snippets and release notes to markdown #63710

Merged
merged 7 commits into from
Feb 17, 2023
Merged

Migrate changelog snippets and release notes to markdown #63710

merged 7 commits into from
Feb 17, 2023

Conversation

s0undt3ch
Copy link
Collaborator

What does this PR do?

See title

@s0undt3ch s0undt3ch requested a review from a team as a code owner February 13, 2023 17:47
@s0undt3ch s0undt3ch requested review from garethgreenaway and removed request for a team February 13, 2023 17:47
@s0undt3ch s0undt3ch force-pushed the hotfix/markdown branch 5 times, most recently from 3e468ee to c47430b Compare February 13, 2023 21:21
@s0undt3ch s0undt3ch changed the title Migrate changelog snippets to markdown Migrate changelog snippets and release notes to markdown Feb 13, 2023
barbaricyawps
barbaricyawps previously approved these changes Feb 13, 2023
View reviewed changes
Copy link
Contributor

@barbaricyawps barbaricyawps left a comment

Choose a reason for hiding this comment

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

Nice! Looks good to me. Have you tested whether it builds correctly in the docs? I think there are a few changes that need to be in the configuration (or possibly adding an extension) to get it to work. Is that included in this commit?

@s0undt3ch
Copy link
Collaborator Author

Nice! Looks good to me. Have you tested whether it builds correctly in the docs? I think there are a few changes that need to be in the configuration (or possibly adding an extension) to get it to work. Is that included in this commit?

There's definitely some issues with the rendered release notes....

image

Moving PR to draft.

@s0undt3ch s0undt3ch marked this pull request as draft February 13, 2023 21:58
@s0undt3ch
Copy link
Collaborator Author

docs.tar.gz

Rendering issues addressed.

@s0undt3ch s0undt3ch marked this pull request as ready for review February 13, 2023 22:16
twangboy
twangboy previously approved these changes Feb 14, 2023
View reviewed changes
Ch3LL
Ch3LL suggested changes Feb 15, 2023
View reviewed changes
Copy link
Contributor

@Ch3LL Ch3LL left a comment

Choose a reason for hiding this comment

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

Will PR submitters need to include the .md file extension now? If so, we need to update the documentation.

@s0undt3ch
Copy link
Collaborator Author

Will PR submitters need to include the .md file extension now? If so, we need to update the documentation.

Yes, they will, and pre-commit will tell them that.

@s0undt3ch
Copy link
Collaborator Author

Which doc?

@s0undt3ch
Converted the changelog setup to markdown
ef44c54 
Signed-off-by: Pedro Algarvio <[email protected]>
@s0undt3ch
Move the check-changelog-entries pre-commit local hook to tools.
441d006 
Signed-off-by: Pedro Algarvio <[email protected]>
@s0undt3ch
Start writing the release notes in markdown.
220dc72 
Signed-off-by: Pedro Algarvio <[email protected]>
@s0undt3ch
Properly handle, and display, errors.
9a8f5f2 
Signed-off-by: Pedro Algarvio <[email protected]>
@s0undt3ch
Set the LATEST_RELEASE environment variable when building docs
0e2ad07 
Signed-off-by: Pedro Algarvio <[email protected]>
@s0undt3ch
Update the changelog nox session to redirect to tools and warn ab…
d5d0fe5 
…out new usage

Signed-off-by: Pedro Algarvio <[email protected]>
@s0undt3ch
Update the changelog related documentation
2d8af8f 
Signed-off-by: Pedro Algarvio <[email protected]>
@s0undt3ch
Copy link
Collaborator Author

Docs updated and also the changelog target for nox.

@s0undt3ch
Copy link
Collaborator Author

Failing build has nothing to do with the changes and review comments have been addressed. Merging.

@s0undt3ch s0undt3ch merged commit b15106b into saltstack:master Feb 17, 2023
@s0undt3ch s0undt3ch deleted the hotfix/markdown branch February 17, 2023 05:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@garethgreenaway garethgreenaway Awaiting requested review from garethgreenaway garethgreenaway was automatically assigned from saltstack/team-core

@Ch3LL Ch3LL Awaiting requested review from Ch3LL

@barbaricyawps barbaricyawps Awaiting requested review from barbaricyawps

@twangboy twangboy Awaiting requested review from twangboy

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@s0undt3ch @Ch3LL @twangboy @barbaricyawps