From c10ff251d5db60de19dd263b344831873a01bcb3 Mon Sep 17 00:00:00 2001 From: Micheal Wilkinson Date: Thu, 19 Mar 2026 16:26:31 +0000 Subject: [PATCH] docs(changelog): update formatting --- ChangeLog.markdown | 126 ------------------------ changelog.md | 240 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 240 insertions(+), 126 deletions(-) delete mode 100644 ChangeLog.markdown create mode 100644 changelog.md diff --git a/ChangeLog.markdown b/ChangeLog.markdown deleted file mode 100644 index e598d92..0000000 --- a/ChangeLog.markdown +++ /dev/null @@ -1,126 +0,0 @@ -# 1.1.6 - * Makesure the FileUtils is imported correctly to avoid a potential error - * Fixes an issue where comparing a diff would not use the content of the new file - * Small documentation fixes - -# 1.1.5 - * Fixed problem with version number being incorrect. - -# 1.1.4 - * Make sure symlink conflicts are explicitly communicated to a user and symlinks are not silently overwritten - * Use real paths of symlinks when linking a castle into home - * Fix a problem when in a diff when asking a user to resolve a conflict - * Some code refactoring and fixes - -# 1.1.3 - * Allow a destination to be passed when cloning a castle - * Make sure `homesick edit` opens default editor in the root of the given castle - * Fixed bug when diffing edited files - * Fixed crashing bug when attempting to diff directories - * Ensure that messages are escaped correctly on `git commit all` - -# 1.1.2 - * Added '--force' option to the rc command to bypass confirmation checks when running a .homesickrc file - * Added a check to make sure that a minimum of Git 1.8.0 is installed. This stops Homesick failing silently if Git is not installed. - * Code refactoring and fixes. - -# 1.1.0 - * Added exec and exec_all commands to run commands inside one or all clones castles. - * Code refactoring. - -# 1.0.0 - * Removed support for Ruby 1.8.7 - * Added a version command - -# 0.9.8 - * Introduce new commands - * `homesick cd` - * `homesick open` - -# 0.9.4 - * Use https protocol instead of git protocol - * Introduce new commands - * `homesick unlink` - * `homesick rc` - -# 0.9.3 - * Add recursive option to `homesick clone` - -# 0.9.2 - * Set "dotfiles" as default castle name - * Introduce new commands - * `homesick show_path` - * `homesick status` - * `homesick diff` - -# 0.9.1 - * Fixed small bugs: #35, #40 - -# 0.9.0 - * Introduce .homesick_subdir #39 - -# 0.8.1 - * Fixed `homesick list` bug on ruby 2.0 #37 - -# 0.8.0 - * Introduce commit & push command - * commit changes in castle and push to remote - * Enable recursive submodule update - * Git add when track - -# 0.7.0 - * Fixed double-cloning #14 - * New option for pull command: --all - * pulls each castle, instead of just one - -# 0.6.1 - - * Add a license - -# 0.6.0 - - * Introduce .homesickrc - * Castles can now have a .homesickrc inside them - * On clone, this is eval'd inside the destination directory - * Introduce track command - * Allows easily moving an existing file into a castle, and symlinking it back - -# 0.5.0 - - * Fixed listing of castles cloned using `homesick clone /` (issue 3) - * Added `homesick pull ` for updating castles (thanks Jorge Dias!) - * Added a very basic `homesick generate ` - -# 0.4.1 - - * Improved error message when a castle's home dir doesn't exist - -# 0.4.0 - - * `homesick clone` can now take a path to a directory on the filesystem, which will be symlinked into place - * `homesick clone` now tries to `git submodule init` and `git submodule update` if git submodules are defined for a cloned repo - * Fixed missing dependency on thor and others - * Use HOME environment variable for where to store files, instead of assuming ~ - -# 0.3.0 - - * Renamed 'link' to 'symlink' - * Fixed conflict resolution when symlink destination exists and is a normal file - -# 0.2.0 - - * Better support for recognizing git urls (thanks jacobat!) - * if it looks like a github user/repo, do that - * otherwise hand off to git clone - * Listing now displays in color, and show git remote - * Support pretend, force, and quiet modes - -# 0.1.1 - - * Fixed trying to link against castles that don't exist - * Fixed linking, which tries to exclude . and .. from the list of files to - link (thanks Martinos!) - -# 0.1.0 - - * Initial release diff --git a/changelog.md b/changelog.md new file mode 100644 index 0000000..7025b31 --- /dev/null +++ b/changelog.md @@ -0,0 +1,240 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## [1.1.6] - 2017-12-20 + +### Fixed + +- Ensure `FileUtils` is imported correctly to avoid a potential error. +- Fix an issue where comparing a diff did not use the content of the new file. + +### Changed + +- Small documentation fixes. + +## [1.1.5] - 2017-03-23 + +### Fixed + +- Problem with version number being incorrect. + +## [1.1.4] - 2017-03-22 + +### Fixed + +- Ensure symlink conflicts are explicitly communicated to users and symlinks are not silently overwritten. +- Fix a problem in diff when asking a user to resolve a conflict. + +### Changed + +- Use real paths of symlinks when linking a castle into home. +- Code refactoring and fixes. + +## [1.1.3] - 2015-10-31 + +### Added + +- Allow a destination to be passed when cloning a castle. + +### Fixed + +- Make sure `homesick edit` opens the default editor in the root of the given castle. +- Bug when diffing edited files. +- Crashing bug when attempting to diff directories. +- Ensure that messages are escaped correctly on `git commit all`. + +## [1.1.2] - 2015-01-02 + +### Added + +- `--force` option to the rc command to bypass confirmation checks when running a `.homesickrc` file. +- Check to ensure that at least Git 1.8.0 is installed. + +### Fixed + +- Stop Homesick failing silently when Git is not installed. + +### Changed + +- Code refactoring and fixes. + +## [1.1.0] - 2014-04-28 + +### Added + +- `exec` and `exec_all` commands to run commands inside one or all cloned castles. + +### Changed + +- Code refactoring. + +## [1.0.0] - 2014-01-15 + +### Added + +- `version` command. + +### Removed + +- Support for Ruby 1.8.7. + +## [0.9.8] - 2014-01-02 + +### Added + +- `homesick cd` command. +- `homesick open` command. + +## [0.9.4] - 2013-07-31 + +### Added + +- `homesick unlink` command. +- `homesick rc` command. + +### Changed + +- Use HTTPS protocol instead of git protocol. + +## [0.9.3] - 2013-07-07 + +### Added + +- Recursive option to `homesick clone`. + +## [0.9.2] - 2013-06-27 + +### Added + +- `homesick show_path` command. +- `homesick status` command. +- `homesick diff` command. + +### Changed + +- Set `dotfiles` as default castle name. + +## [0.9.1] - 2013-06-17 + +### Fixed + +- Small bugs: #35, #40. + +## [0.9.0] - 2013-06-06 + +### Added + +- `.homesick_subdir` (#39). + +## [0.8.1] - 2013-05-19 + +### Fixed + +- `homesick list` bug on Ruby 2.0 (#37). + +## [0.8.0] - 2013-04-06 + +### Added + +- `commit` and `push` command. +- Commit changes in a castle and push to remote. +- Enable recursive submodule update. +- Git add when using track. + +## [0.7.0] - 2012-05-28 + +### Added + +- New option for pull command: `--all`. +- Pull each castle instead of just one. + +### Fixed + +- Double-cloning (#14). + +## [0.6.1] - 2010-11-13 + +### Added + +- License. + +## [0.6.0] - 2010-10-27 + +### Added + +- `.homesickrc` support. +- Castles can now have a `.homesickrc` inside them. +- On clone, this is eval'd inside the destination directory. +- `track` command. +- Allows easily moving an existing file into a castle and symlinking it back. + +## [0.5.0] - 2010-05-18 + +### Added + +- `homesick pull ` for updating castles (thanks Jorge Dias). +- A very basic `homesick generate `. + +### Fixed + +- Listing of castles cloned using `homesick clone /` (issue 3). + +## [0.4.1] - 2010-04-02 + +### Fixed + +- Improve error message when a castle's home dir does not exist. + +## [0.4.0] - 2010-04-01 + +### Added + +- `homesick clone` can take a path to a directory on the filesystem, which is symlinked into place. +- `homesick clone` tries to run `git submodule init` and `git submodule update` if git submodules are defined for a cloned repo. + +### Changed + +- Use `HOME` environment variable for where to store files, instead of assuming `~`. + +### Fixed + +- Missing dependency on thor and others. + +## [0.3.0] - 2010-04-01 + +### Changed + +- Rename `link` to `symlink`. + +### Fixed + +- Conflict resolution when symlink destination exists and is a normal file. + +## [0.2.0] - 2010-03-19 + +### Added + +- Better support for recognizing git URLs (thanks jacobat). +- If it looks like a GitHub user/repo, use that. +- Otherwise hand off to git clone. +- Listing now displays in color and shows git remote. +- Support pretend, force, and quiet modes. + +## [0.1.1] - 2010-03-17 + +### Fixed + +- Trying to link against castles that do not exist. +- Linking now excludes `.` and `..` from the list of files to link (thanks Martinos). + +## [0.1.0] - 2010-03-10 + +### Added + +- Initial release.