diff --git a/.markdownlint.yaml b/.markdownlint.yaml index 99d7554..c38d4e2 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -1,3 +1,4 @@ line-length: false no-duplicate-heading: false no-emphasis-as-heading: false +no-bare-urls: false diff --git a/CHANGELOG.md b/CHANGELOG.md index ea45869..9a3a460 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,8 +2,30 @@ ## Development +### Notes + +### Commits + +## v0.1.1 + +### Notes + +1. Deploy to Github Pages. + +### Pull Requests + +* [```pull/3```](https://github.com/ktmeaton/autologs/pull/3) Fix Jekyll Config + ### Commits +* [```4d43066```](https://github.com/ktmeaton/autologs/commit/4d43066) Merge pull request #3 from ktmeaton/dev +* [```ed21463```](https://github.com/ktmeaton/autologs/commit/ed21463) fix jekyll config linting +* [```bd19b91```](https://github.com/ktmeaton/autologs/commit/bd19b91) Merge branch 'main' of https://github.com/ktmeaton/autologs into main +* [```fc54f6f```](https://github.com/ktmeaton/autologs/commit/fc54f6f) alternate way of showing output +* [```a949079```](https://github.com/ktmeaton/autologs/commit/a949079) Set theme jekyll-theme-slate +* [```8e8919d```](https://github.com/ktmeaton/autologs/commit/8e8919d) add description of optional notes files for release +* [```8bc9b1b```](https://github.com/ktmeaton/autologs/commit/8bc9b1b) update usage docs + ## v0.1.0 ### Notes @@ -23,6 +45,7 @@ ### Commits +* [```abe0fe2```](https://github.com/ktmeaton/autologs/commit/abe0fe2) rename notes and fix pr title * [```c033197```](https://github.com/ktmeaton/autologs/commit/c033197) move new tag naming into release * [```ce2fded```](https://github.com/ktmeaton/autologs/commit/ce2fded) fix pr dependency on max commits * [```d058793```](https://github.com/ktmeaton/autologs/commit/d058793) fix ver vs tag typo diff --git a/README.md b/README.md index f8e0819..a340d27 100644 --- a/README.md +++ b/README.md @@ -58,31 +58,26 @@ autologs --commits --max-commits 3 ### Release Notes ``` bash -autologs --release --new-tag v0.1.0 --max-commits 3 +autologs --release --old-tag v0.1.0 --new-tag v0.1.1 --max-commits 5 ``` -**v0.1.0** +**v0.1.1** **Notes** -1. Create repository. -1. Add scripts. -1. Add release workflow. -1. Remove hard-coded variables. -1. Simplify script naming. -1. Create the autologs main executable. -1. Make autologs a standalone executable. +1. Deploy to Github Pages. **Pull Requests** -* [```pull/2```](https://github.com/ktmeaton/autologs/pull/2) Prelim Commit Documentation -* [```pull/1```](https://github.com/ktmeaton/autologs/pull/1) Installation Docs +* [```pull/3```](https://github.com/ktmeaton/autologs/pull/3) Fix Jekyll Config **Commits** -* [```abe0fe2```](https://github.com/ktmeaton/autologs/commit/abe0fe2) rename notes and fix pr title -* [```c033197```](https://github.com/ktmeaton/autologs/commit/c033197) move new tag naming into release -* [```ce2fded```](https://github.com/ktmeaton/autologs/commit/ce2fded) fix pr dependency on max commits +* [```4d43066```](https://github.com/ktmeaton/autologs/commit/4d43066) Merge pull request #3 from ktmeaton/dev +* [```ed21463```](https://github.com/ktmeaton/autologs/commit/ed21463) fix jekyll config linting +* [```bd19b91```](https://github.com/ktmeaton/autologs/commit/bd19b91) Merge branch 'main' of https://github.com/ktmeaton/autologs into main +* [```fc54f6f```](https://github.com/ktmeaton/autologs/commit/fc54f6f) alternate way of showing output +* [```a949079```](https://github.com/ktmeaton/autologs/commit/a949079) Set theme jekyll-theme-slate The optional section "### Notes" will appear if a notes file matching the tag name exists. The notes file must contain an enumerated list of notes. @@ -101,7 +96,7 @@ matching file: docs/notes/Notes_v0.1.0.md ### Changelog ```bash -autologs --changelog +autologs --changelog -o CHANGELOG.md ``` See [CHANGELOG.md](https://github.com/ktmeaton/autologs/blob/v0.1.0/CHANGELOG.md) for full output. diff --git a/autologs b/autologs index 4b270bd..6607fcc 100755 --- a/autologs +++ b/autologs @@ -146,8 +146,12 @@ Release() if [[ -f $target_notes ]]; then echo "### Notes" echo - grep -r '[0-9]\. ' $target_notes - echo + notes=`grep -r '[0-9]\. ' $target_notes` + + if [[ $notes ]]; then + echo -e "$notes"; + echo + fi fi #------------------------------------ diff --git a/docs/notes/Notes_Development.md b/docs/notes/Notes_Development.md index 316407e..e69de29 100644 --- a/docs/notes/Notes_Development.md +++ b/docs/notes/Notes_Development.md @@ -1,3 +0,0 @@ -# Development - -1. Begin next version. diff --git a/docs/notes/Notes_v0.1.1.md b/docs/notes/Notes_v0.1.1.md new file mode 100644 index 0000000..e6942b3 --- /dev/null +++ b/docs/notes/Notes_v0.1.1.md @@ -0,0 +1,3 @@ +# Development + +1. Deploy to Github Pages.