Skip to content

Commit

Permalink
tidy up v0.1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
ktmeaton committed Feb 18, 2021
1 parent 4d43066 commit d62e57d
Show file tree
Hide file tree
Showing 6 changed files with 43 additions and 20 deletions.
1 change: 1 addition & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
line-length: false
no-duplicate-heading: false
no-emphasis-as-heading: false
no-bare-urls: false
23 changes: 23 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
25 changes: 10 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down
8 changes: 6 additions & 2 deletions autologs
Original file line number Diff line number Diff line change
Expand Up @@ -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

#------------------------------------
Expand Down
3 changes: 0 additions & 3 deletions docs/notes/Notes_Development.md
Original file line number Diff line number Diff line change
@@ -1,3 +0,0 @@
# Development

1. Begin next version.
3 changes: 3 additions & 0 deletions docs/notes/Notes_v0.1.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Development

1. Deploy to Github Pages.

0 comments on commit d62e57d

Please sign in to comment.