Skip to content

Commit

Permalink
feat: add rst to md conversion for gh release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
JacobCoffee committed Jun 25, 2023
1 parent 7bc5009 commit 0e42390
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,14 @@ repos:
hooks:
- id: prettier
exclude: "_templates"
- repo: https://github.com/koalaman/shellcheck-precommit
rev: v0.9.0
hooks:
- id: shellcheck
- repo: https://github.com/lovesegfault/beautysh.git
rev: v6.2.1
hooks:
- id: beautysh
- repo: https://github.com/python-formate/flake8-dunder-all
rev: v0.3.0
hooks:
Expand Down
43 changes: 43 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Changelog

All commits to this project will be documented in this file.

## [Release \[v0.2.0\] - 2023-06-25](https://github.com/JacobCoffee/niapi/releases/tag/v0.2.0)

- [See All commits in v0.2.0](https://github.com/JacobCoffee/niapi/commits/v0.2.0)

### Bug Fixes

- ([18656a3](https://github.com/JacobCoffee/niapi/commit/18656a33bf9a2499bc3b3679b3abb308d12caf29)) - Resolves issue with footer color (Jacob Coffee)
- ([b20aa59](https://github.com/JacobCoffee/niapi/commit/b20aa5964ae65221950eea1a44138f68db63d72c)) - Fix border dark style (Jacob Coffee)

### Documentation

- ([7021fbf](https://github.com/JacobCoffee/niapi/commit/7021fbf5d54e856933103a63e5b1adeaf79c6776)) - Fix README.md (Jacob Coffee)
- ([4f062f2](https://github.com/JacobCoffee/niapi/commit/4f062f25b21af27e166e98e020051df3419fa259)) - Fix name (Jacob Coffee)
- ([ac3528d](https://github.com/JacobCoffee/niapi/commit/ac3528d78bcbf4846426c1c32e42e0e3ded3829a)) - Fix name (Jacob Coffee)
- ([c5e3521](https://github.com/JacobCoffee/niapi/commit/c5e3521173daaa069c6bed8ed647f62dfbbed1ae)) - Add snyk (Jacob Coffee)
- ([90eecbd](https://github.com/JacobCoffee/niapi/commit/90eecbd190ec58dda17edad0ae8e5c91816cb75d)) - Use thin logo for readme (Jacob Coffee)
- ([d0e3dab](https://github.com/JacobCoffee/niapi/commit/d0e3dab35de79b88f6b9227b207caff2279a9414)) - Add index image (Jacob Coffee)

### Features

- ([995876a](https://github.com/JacobCoffee/niapi/commit/995876a3758afb801829b8bc3d98f4331fd59273)) - Initial commit (Jacob Coffee)
- ([93fe748](https://github.com/JacobCoffee/niapi/commit/93fe74805e83de71805c8181a35c8ca4a8a8c3a4)) - Adds basic scaffolding (Jacob Coffee)
- ([667fda2](https://github.com/JacobCoffee/niapi/commit/667fda29775ab01201d8044b69c1c92d73a61d4e)) - Style updates (Jacob Coffee)
- ([058a0c7](https://github.com/JacobCoffee/niapi/commit/058a0c719a4531884cca4a28978e3884e30ff957)) - Style updates (Jacob Coffee)
- ([82aeba5](https://github.com/JacobCoffee/niapi/commit/82aeba5e354f91ee3a07bfc2a52c97804a1f2321)) - Introduce changelog and doc styling (Jacob Coffee)

### Ci

- ([915b732](https://github.com/JacobCoffee/niapi/commit/915b732492f91fcd8a59cfee9b6ce66b0eba2030)) - Remove early 3.12 usage (Jacob Coffee)
- ([988659d](https://github.com/JacobCoffee/niapi/commit/988659d7944ad90d617360261e04e38325ddd0cf)) - Update ci name (Jacob Coffee)
- ([ad08c17](https://github.com/JacobCoffee/niapi/commit/ad08c17c395670fbb7f23a1644d2b8f1e904037e)) - Update ci name (Jacob Coffee)
- ([0596b7c](https://github.com/JacobCoffee/niapi/commit/0596b7cb2c97cf2c58b2e8900acafa183b3bcf87)) - Full pre-commit passing (Jacob Coffee)

### Release

- ([4cd39be](https://github.com/JacobCoffee/niapi/commit/4cd39be2c0321464e4273548048bb9f44fc2c47f)) - Version v0.2.0 (Jacob Coffee)
- ([e736a00](https://github.com/JacobCoffee/niapi/commit/e736a003b7d80290023e55f184af503315febe6b)) - Version v0.2.0 (Jacob Coffee)

Network Information API Changelog
7 changes: 7 additions & 0 deletions tools/convert_docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/bin/bash

CHANGELOG=docs/changelog.rst

filename="${CHANGELOG%.*}"
echo "Converting $CHANGELOG to $filename.md"
pandoc --wrap=preserve $CHANGELOG -f rst -t markdown -o "$filename".md

0 comments on commit 0e42390

Please sign in to comment.