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: Combine CHANGELOG.rst with CHANGELOG.md #1228

Merged
merged 4 commits into from Oct 21, 2021

Conversation

ashwinvis
Copy link
Contributor

@ashwinvis ashwinvis commented Oct 21, 2021

  • docs: Convert old changelog from rst -> markdown
  • chore: Use myst-parser for markdown files
  • chore: Remove CHANGELOG.rst

Description

QC

  • The PR contains a test case for the changes or the changes are already covered by an existing test case.
  • The documentation (docs/) is updated to reflect the changes or this is not necessary (e.g. if the change does neither modify the language nor the behavior or functionalities of Snakemake).

ashwinvis added 3 commits Oct 21, 2021
Using pandoc -t commonmark CHANGELOG.rst > CHANGELOG.md
Then, adjusted the heading levels
@ashwinvis ashwinvis requested a review from johanneskoester as a code owner Oct 21, 2021
@ashwinvis ashwinvis changed the title Combine CHANGELOG.rst with CHANGELOG.md docs: Combine CHANGELOG.rst with CHANGELOG.md Oct 21, 2021
@ashwinvis ashwinvis marked this pull request as draft Oct 21, 2021
@sonarcloud
Copy link

sonarcloud bot commented Oct 21, 2021

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
0.0% 0.0% Duplication

@ashwinvis ashwinvis marked this pull request as ready for review Oct 21, 2021
Copy link
Contributor

@johanneskoester johanneskoester left a comment

Thanks a lot!

@johanneskoester johanneskoester merged commit 19f5a43 into snakemake:main Oct 21, 2021
7 checks passed
pvandyken pushed a commit to pvandyken/snakemake that referenced this pull request Nov 15, 2021
* docs: Convert old changelog from rst -> markdown

Using pandoc -t commonmark CHANGELOG.rst > CHANGELOG.md
Then, adjusted the heading levels

* chore: Use myst-parser for markdown files

Show CHANGELOG.md in docs

* chore: Remove CHANGELOG.rst

* docs: correct changelog rst->md conversion artefacts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants