Skip to content

Commit

Permalink
docs: update workflow section in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adamtabrams committed Jun 6, 2020
1 parent d94691c commit a52efe6
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 5 deletions.
76 changes: 75 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.6.1] - 2020-06-06
### Fixed
- Error handling within functions. Replaced exit with return.
- Removed editor prompt when amending with all command.

### Changed
- Update workflow section in readme.

## [0.6.0] - 2020-06-06
### Added
- Created a change all command for improved workflow.
Expand All @@ -14,6 +22,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed
- Corrected typo in regex for sorting commits.

## [0.6.1] - 2020-06-06
### Fixed
- Error handling and all command.

### Changed
- Update workflow section in readme.

## [0.6.0] - 2020-06-06
### Added
- Add change all command.
Expand All @@ -29,6 +44,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Version sorting needed to be reversed.
- Escape more character for use in sed and curl.

## [0.6.1] - 2020-06-06
### Fixed
- Error handling and all command.

### Changed
- Update workflow section in readme.

## [0.6.0] - 2020-06-06
### Added
- Add change all command.
Expand All @@ -52,6 +74,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed
- Improve usage message added Tips section to README.

## [0.6.1] - 2020-06-06
### Fixed
- Error handling and all command.

### Changed
- Update workflow section in readme.

## [0.6.0] - 2020-06-06
### Added
- Add change all command.
Expand Down Expand Up @@ -87,6 +116,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Changed `release` command to `post`.
- Changed `-t` command to `tag`.

## [0.6.1] - 2020-06-06
### Fixed
- Error handling and all command.

### Changed
- Update workflow section in readme.

## [0.6.0] - 2020-06-06
### Added
- Add change all command.
Expand Down Expand Up @@ -121,6 +157,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed
- Error handling for unknown arguments.

## [0.6.1] - 2020-06-06
### Fixed
- Error handling and all command.

### Changed
- Update workflow section in readme.

## [0.6.0] - 2020-06-06
### Added
- Add change all command.
Expand Down Expand Up @@ -164,6 +207,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed
- Add changelog for the project (shocker right).

## [0.6.1] - 2020-06-06
### Fixed
- Error handling and all command.

### Changed
- Update workflow section in readme.

## [0.6.0] - 2020-06-06
### Added
- Add change all command.
Expand Down Expand Up @@ -218,6 +268,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed
- Add About and Usage sections to README.

## [0.6.1] - 2020-06-06
### Fixed
- Error handling and all command.

### Changed
- Update workflow section in readme.

## [0.6.0] - 2020-06-06
### Added
- Add change all command.
Expand Down Expand Up @@ -277,6 +334,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Completely refactored the tool.
- Created feature for generating the initial changelog.

## [0.6.1] - 2020-06-06
### Fixed
- Error handling and all command.

### Changed
- Update workflow section in readme.

## [0.6.0] - 2020-06-06
### Added
- Add change all command.
Expand Down Expand Up @@ -339,7 +403,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added
- Created a proof of concept for a changelog updater.

[Unreleased]: https://github.com/adamtabrams/change/compare/0.6.0...HEAD
[Unreleased]: https://github.com/adamtabrams/change/compare/0.6.1...HEAD
[0.6.1]: https://github.com/adamtabrams/change/compare/0.6.0...0.6.1
[0.6.0]: https://github.com/adamtabrams/change/compare/0.5.2...0.6.0
[0.5.2]: https://github.com/adamtabrams/change/compare/0.5.1...0.5.2
[0.5.1]: https://github.com/adamtabrams/change/compare/0.5.0...0.5.1
Expand All @@ -349,34 +414,42 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
[0.3.0]: https://github.com/adamtabrams/change/compare/0.2.0...0.3.0
[0.2.0]: https://github.com/adamtabrams/change/compare/0.1.0...0.2.0
[0.1.0]: https://github.com/adamtabrams/change/compare/0.6.0...0.1.0
[0.6.1]: https://github.com/adamtabrams/change/compare/0.6.0...0.6.1
[0.6.0]: https://github.com/adamtabrams/change/compare/0.5.2...0.6.0
[0.6.1]: https://github.com/adamtabrams/change/compare/0.6.0...0.6.1
[0.6.0]: https://github.com/adamtabrams/change/compare/0.5.2...0.6.0
[0.5.2]: https://github.com/adamtabrams/change/compare/0.5.1...0.5.2
[0.6.1]: https://github.com/adamtabrams/change/compare/0.6.0...0.6.1
[0.6.0]: https://github.com/adamtabrams/change/compare/0.5.2...0.6.0
[0.5.2]: https://github.com/adamtabrams/change/compare/0.5.1...0.5.2
[0.5.1]: https://github.com/adamtabrams/change/compare/0.5.0...0.5.1
[0.6.1]: https://github.com/adamtabrams/change/compare/0.6.0...0.6.1
[0.6.0]: https://github.com/adamtabrams/change/compare/0.5.2...0.6.0
[0.5.2]: https://github.com/adamtabrams/change/compare/0.5.1...0.5.2
[0.5.1]: https://github.com/adamtabrams/change/compare/0.5.0...0.5.1
[0.5.0]: https://github.com/adamtabrams/change/compare/0.4.1...0.5.0
[0.6.1]: https://github.com/adamtabrams/change/compare/0.6.0...0.6.1
[0.6.0]: https://github.com/adamtabrams/change/compare/0.5.2...0.6.0
[0.5.2]: https://github.com/adamtabrams/change/compare/0.5.1...0.5.2
[0.5.1]: https://github.com/adamtabrams/change/compare/0.5.0...0.5.1
[0.5.0]: https://github.com/adamtabrams/change/compare/0.4.1...0.5.0
[0.4.1]: https://github.com/adamtabrams/change/compare/0.4.0...0.4.1
[0.6.1]: https://github.com/adamtabrams/change/compare/0.6.0...0.6.1
[0.6.0]: https://github.com/adamtabrams/change/compare/0.5.2...0.6.0
[0.5.2]: https://github.com/adamtabrams/change/compare/0.5.1...0.5.2
[0.5.1]: https://github.com/adamtabrams/change/compare/0.5.0...0.5.1
[0.5.0]: https://github.com/adamtabrams/change/compare/0.4.1...0.5.0
[0.4.1]: https://github.com/adamtabrams/change/compare/0.4.0...0.4.1
[0.4.0]: https://github.com/adamtabrams/change/compare/0.3.0...0.4.0
[0.6.1]: https://github.com/adamtabrams/change/compare/0.6.0...0.6.1
[0.6.0]: https://github.com/adamtabrams/change/compare/0.5.2...0.6.0
[0.5.2]: https://github.com/adamtabrams/change/compare/0.5.1...0.5.2
[0.5.1]: https://github.com/adamtabrams/change/compare/0.5.0...0.5.1
[0.5.0]: https://github.com/adamtabrams/change/compare/0.4.1...0.5.0
[0.4.1]: https://github.com/adamtabrams/change/compare/0.4.0...0.4.1
[0.4.0]: https://github.com/adamtabrams/change/compare/0.3.0...0.4.0
[0.3.0]: https://github.com/adamtabrams/change/compare/0.2.0...0.3.0
[0.6.1]: https://github.com/adamtabrams/change/compare/0.6.0...0.6.1
[0.6.0]: https://github.com/adamtabrams/change/compare/0.5.2...0.6.0
[0.5.2]: https://github.com/adamtabrams/change/compare/0.5.1...0.5.2
[0.5.1]: https://github.com/adamtabrams/change/compare/0.5.0...0.5.1
Expand All @@ -385,6 +458,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
[0.4.0]: https://github.com/adamtabrams/change/compare/0.3.0...0.4.0
[0.3.0]: https://github.com/adamtabrams/change/compare/0.2.0...0.3.0
[0.2.0]: https://github.com/adamtabrams/change/compare/0.1.0...0.2.0
[0.6.1]: https://github.com/adamtabrams/change/compare/0.6.0...0.6.1
[0.6.0]: https://github.com/adamtabrams/change/compare/0.5.2...0.6.0
[0.5.2]: https://github.com/adamtabrams/change/compare/0.5.1...0.5.2
[0.5.1]: https://github.com/adamtabrams/change/compare/0.5.0...0.5.1
Expand Down
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,10 @@ This is the general workflow I use with this tool:
* make changes to your project
* record those changes in commits
* smaller, more focused commits will help when generating the changelog
* run `change`
* run `change all`
* improve the new section of the changelog
* ammend the revised changelog to the last commit with `git commit --amend`
* run `change tag`
* save and close the file
* push to origin
* run `change post`


# Tips
Expand Down

0 comments on commit a52efe6

Please sign in to comment.