-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use Changelog.jl for CHANGELOG.md (#86)
- Loading branch information
Showing
6 changed files
with
177 additions
and
92 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1 @@ | ||
| docs/ | ||
| Manifest.toml | ||
| /Manifest.toml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,135 +1,183 @@ | ||
| # DocumenterTools.jl changelog | ||
| # Release notes | ||
|
|
||
| ## Version `v0.1.19` | ||
| The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | ||
| and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
|
||
| * Update the instructions about the GitHub interface `genkeys` prints. ([#84][github-84], [#85][github-85]) | ||
| ## Version [v0.1.19] -- 2024-01-28 | ||
|
|
||
| ## Version `v0.1.18` | ||
| ### Changed | ||
|
|
||
| * Declare compatibility with Documenter 1.0. ([#80][github-80], [#81][github-81]) | ||
| * Update the instructions about the GitHub interface `genkeys` prints. ([#84], [#85]) | ||
|
|
||
| ## Version `v0.1.17` | ||
| ## Version [v0.1.18] -- 2023-09-27 | ||
|
|
||
| * ![Enhancement][badge-enhancement] The compiled CSS files generated by DocumenterTools are now minified. ([#71][github-71]) | ||
| ### Changed | ||
|
|
||
| ## Version `v0.1.16` | ||
| * Declare compatibility with Documenter 1.0. ([#80], [#81]) | ||
|
|
||
| * ![Bugfix][badge-bugfix] DocumenterTools now runs `ssh-keygen` in a temporary directory (rather than current working directory), avoiding issues with filesystem permissions or existing files. ([#64][github-64], [#65][github-65]) | ||
| ## Version [v0.1.17] -- 2023-06-29 | ||
|
|
||
| ## Version `v0.1.15` | ||
| ### Changed | ||
|
|
||
| * Declare compatibility with DocStringExtensions 0.9. ([#59][github-59]) | ||
| * Declare compatibility with AbstractTrees 0.4. ([#60][github-60]) | ||
| * The compiled CSS files generated by DocumenterTools are now minified. ([#71]) | ||
|
|
||
| ## Version `v0.1.14` | ||
| ## Version [v0.1.16] -- 2022-09-14 | ||
|
|
||
| ### Fixed | ||
|
|
||
| * DocumenterTools now runs `ssh-keygen` in a temporary directory (rather than current working directory), avoiding issues with filesystem permissions or existing files. ([#64], [#65]) | ||
|
|
||
| ## Version [v0.1.15] -- 2022-07-24 | ||
|
|
||
| ### Changed | ||
|
|
||
| * Declare compatibility with DocStringExtensions 0.9. ([#59]) | ||
| * Declare compatibility with AbstractTrees 0.4. ([#60]) | ||
|
|
||
| ## Version [v0.1.14] -- 2022-05-08 | ||
|
|
||
| ### Changed | ||
|
|
||
| * DocumenterTools now requires at least Julia 1.6. | ||
| * ![Enhancement][badge-enhancement] `DocumenterTools.genkeys` function now uses the `OpenSSH_jll` for the `ssh-keygen` binary and therefore no longer requires the user to have OpenSSH installed. ([#36][github-36], [#56][github-56]) | ||
| * ![Enhancement][badge-enhancement] Improvements to the documentation of `OutdatedWarning.generate` and it now also prints a warning in the terminal. ([#55][github-55]) | ||
| * ![Bugfix][badge-bugfix] DocumenterTools now always generated the SSH keys in the PEM file format to make sure that they also work on older systems. ([#48][github-48]) | ||
| * `DocumenterTools.genkeys` function now uses the `OpenSSH_jll` for the `ssh-keygen` binary and therefore no longer requires the user to have OpenSSH installed. ([#36], [#56]) | ||
| * Improvements to the documentation of `OutdatedWarning.generate` and it now also prints a warning in the terminal. ([#55]) | ||
|
|
||
| ### Fixed | ||
|
|
||
| * DocumenterTools now always generated the SSH keys in the PEM file format to make sure that they also work on older systems. ([#48]) | ||
|
|
||
| ## Version [v0.1.13] -- 2021-06-17 | ||
|
|
||
| ### Changed | ||
|
|
||
| * The wording of the text in the the old version warning box was improved. ([#54]) | ||
|
|
||
| ## Version [v0.1.12] -- 2021-06-10 | ||
|
|
||
| ### Changed | ||
|
|
||
| * Declared compatibility with Documenter 0.27. ([#52]) | ||
|
|
||
| ## Version [v0.1.11] -- 2021-06-06 | ||
|
|
||
| ### Added | ||
|
|
||
| * DocumenterTools now provides the `OutdatedWarning.generate` function which can be used to add outdated version warnings to old documentation builds (on `gh-pages`). ([#51]) | ||
|
|
||
| ## Version [v0.1.10] -- 2021-04-18 | ||
|
|
||
| ### Changed | ||
|
|
||
| * Declare compatibility with Sass.jl 0.2. ([#49]) | ||
|
|
||
| ## Version [v0.1.9] -- 2020-12-09 | ||
|
|
||
| ## Version `v0.1.13` | ||
| ### Changed | ||
|
|
||
| * ![Enhancement][badge-enhancement] The wording of the text in the the old version warning box was improved. ([#54][github-54]) | ||
| * Declare compatibility with Documenter 0.26. ([#46]) | ||
|
|
||
| ## Version `v0.1.12` | ||
| ## Version [v0.1.8] -- 2020-10-20 | ||
|
|
||
| * Declare compatibility with Documenter 0.27. ([#52][github-52]) | ||
| * Fixes broken links in the documentation ([#43][github-43]) and reliance on old (broken) `pathof` behaviour in the tests ([#44]). | ||
|
|
||
| ## Version `v0.1.11` | ||
| ## Version [v0.1.7] -- 2020-06-24 | ||
|
|
||
| * DocumenterTools now provides the `OutdatedWarning.generate` function which can be used to add outdated version warnings to old documentation builds (on `gh-pages`). ([#51][github-51]) | ||
| ### Changed | ||
|
|
||
| ## Version `v0.1.10` | ||
| `DocumenterTools.genkeys` now puts "Documenter" as the comment in the SSH key file, instead of the default username and hostname. ([#40]) | ||
|
|
||
| * Declare compatibility with Sass.jl 0.2. ([#49][github-49]) | ||
| ## Version [v0.1.6] -- 2020-06-13 | ||
|
|
||
| ## Version `v0.1.9` | ||
| ### Changed | ||
|
|
||
| * Declare compatibility with Documenter 0.26. ([#46][github-46]) | ||
| * Declared compatibility with Documenter 0.25. ([#39]) | ||
|
|
||
| ## Version `v0.1.8` | ||
| ## Version [v0.1.5] -- 2020-03-05 | ||
|
|
||
| * ![Maintenance][badge-maintenance] Fixes broken links in the documentation ([#43][github-43]) and reliance on old (broken) `pathof` behaviour in the tests ([#44][github-44]). | ||
| ### Fixed | ||
|
|
||
| ## Version `v0.1.7` | ||
| * Fixes to the `Themes.compile` function, including making sure that the Sass include path is properly set up. ([#32], [#35]) | ||
|
|
||
| * ![Enhancement][badge-enhancement] `DocumenterTools.genkeys` now puts "Documenter" as the comment in the SSH key file, instead of the default username and hostname. ([#40][github-40]) | ||
| ## Version [v0.1.4] -- 2020-01-10 | ||
|
|
||
| ## Version `v0.1.6` | ||
| ### Fixed | ||
|
|
||
| Maintenance release declaring compatibility with Documenter 0.25. ([#39][github-39]) | ||
| * `Travis.genkeys()` now works on Windows even if the UNIX-y `which` is not available. ([#33]) | ||
|
|
||
| ## Version `v0.1.5` | ||
| ## Version [v0.1.3] -- 2019-11-21 | ||
|
|
||
| * ![Bugfix][badge-bugfix] Fixes to the `Themes.compile` function, including making sure that the Sass include path is properly set up. ([#32][github-32], [#35][github-35]) | ||
| ### Added | ||
|
|
||
| ## Version `v0.1.4` | ||
| * The new `Themes` submodule provides an experimental API to compile Documenter Sass themes. ([#27]) | ||
|
|
||
| * ![Enhancement][badge-enhancement] `Travis.genkeys()` now works on Windows even if the UNIX-y `which` is not available. ([#33][github-33]) | ||
| ## Version [v0.1.2] -- 2019-10-08 | ||
|
|
||
| ## Version `v0.1.3` | ||
| ### Deprecated | ||
|
|
||
| * ![Experimental][badge-experimental] ![Feature][badge-feature] The new `Themes` submodule provides an experimental API to compile Documenter Sass themes. ([#27][github-27]) | ||
| * The `Travis` submodule has been deprecated. Instead of `Travis.genkeys`, use `DocumenterTools.genkeys`. ([#30]) | ||
|
|
||
| ## Version `v0.1.2` | ||
| ## Version [v0.1.1] -- 2019-06-10 | ||
|
|
||
| * ![Deprecation][badge-deprecation] The `Travis` submodule has been deprecated. Instead of `Travis.genkeys`, use `DocumenterTools.genkeys`. ([#30][github-30]) | ||
| ### Added | ||
|
|
||
| ## Version `v0.1.1` | ||
| * The `generate(path::String)` method now defaults to `"docs"` as the default path, allowing it to be simply called as `generate()` in e.g. the root directory of a package. ([#22]) | ||
|
|
||
| * ![Enhancement][badge-enhancement] The `generate(path::String)` method now defaults to `"docs"` as the default path, allowing it to be simply called as `generate()` in e.g. the root directory of a package. ([#22][github-22]) | ||
| ### Changed | ||
|
|
||
| * ![Enhancement][badge-enhancement] The generated values for the `format` argument of `makedocs` are now consistent with the new API introduced in Documenter v0.21. ([#21][github-21]) | ||
| * The generated values for the `format` argument of `makedocs` are now consistent with the new API introduced in Documenter v0.21. ([#21]) | ||
|
|
||
| ## Version `v0.1.0` | ||
| ## Version [v0.1.0] -- 2018-10-29 | ||
|
|
||
| * Initial release. | ||
|
|
||
|
|
||
| [github-21]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/21 | ||
| [github-22]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/22 | ||
| [github-27]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/27 | ||
| [github-30]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/30 | ||
| [github-32]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/32 | ||
| [github-33]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/33 | ||
| [github-35]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/35 | ||
| [github-36]: https://github.com/JuliaDocs/DocumenterTools.jl/issues/36 | ||
| [github-39]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/39 | ||
| [github-40]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/40 | ||
| [github-43]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/43 | ||
| [github-44]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/44 | ||
| [github-46]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/46 | ||
| [github-48]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/48 | ||
| [github-49]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/49 | ||
| [github-51]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/51 | ||
| [github-52]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/52 | ||
| [github-54]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/54 | ||
| [github-55]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/55 | ||
| [github-56]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/56 | ||
| [github-64]: https://github.com/JuliaDocs/DocumenterTools.jl/issues/64 | ||
| [github-65]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/65 | ||
| [github-71]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/71 | ||
| [github-80]: https://github.com/JuliaDocs/DocumenterTools.jl/issues/80 | ||
| [github-81]: https://github.com/JuliaDocs/DocumenterTools.jl/pull/81 | ||
|
|
||
|
|
||
| [badge-breaking]: https://img.shields.io/badge/BREAKING-red.svg | ||
| [badge-deprecation]: https://img.shields.io/badge/deprecation-orange.svg | ||
| [badge-feature]: https://img.shields.io/badge/feature-green.svg | ||
| [badge-enhancement]: https://img.shields.io/badge/enhancement-blue.svg | ||
| [badge-bugfix]: https://img.shields.io/badge/bugfix-purple.svg | ||
| [badge-experimental]: https://img.shields.io/badge/experimental-lightgrey.svg | ||
| [badge-maintenance]: https://img.shields.io/badge/maintenance-gray.svg | ||
|
|
||
| <!-- | ||
| # Badges | ||
| ![BREAKING][badge-breaking] | ||
| ![Deprecation][badge-deprecation] | ||
| ![Feature][badge-feature] | ||
| ![Enhancement][badge-enhancement] | ||
| ![Bugfix][badge-bugfix] | ||
| ![Experimental][badge-experimental] | ||
| ![Maintenance][badge-maintenance] | ||
| --> | ||
| <!-- Links generated by Changelog.jl --> | ||
|
|
||
| [v0.1.0]: https://github.com/JuliaDocs/IOCapture.jl/releases/tag/v0.1.0 | ||
| [v0.1.1]: https://github.com/JuliaDocs/IOCapture.jl/releases/tag/v0.1.1 | ||
| [v0.1.2]: https://github.com/JuliaDocs/IOCapture.jl/releases/tag/v0.1.2 | ||
| [v0.1.3]: https://github.com/JuliaDocs/IOCapture.jl/releases/tag/v0.1.3 | ||
| [v0.1.4]: https://github.com/JuliaDocs/IOCapture.jl/releases/tag/v0.1.4 | ||
| [v0.1.5]: https://github.com/JuliaDocs/IOCapture.jl/releases/tag/v0.1.5 | ||
| [v0.1.6]: https://github.com/JuliaDocs/IOCapture.jl/releases/tag/v0.1.6 | ||
| [v0.1.7]: https://github.com/JuliaDocs/IOCapture.jl/releases/tag/v0.1.7 | ||
| [v0.1.8]: https://github.com/JuliaDocs/IOCapture.jl/releases/tag/v0.1.8 | ||
| [v0.1.9]: https://github.com/JuliaDocs/IOCapture.jl/releases/tag/v0.1.9 | ||
| [v0.1.10]: https://github.com/JuliaDocs/IOCapture.jl/releases/tag/v0.1.10 | ||
| [v0.1.11]: https://github.com/JuliaDocs/IOCapture.jl/releases/tag/v0.1.11 | ||
| [v0.1.12]: https://github.com/JuliaDocs/IOCapture.jl/releases/tag/v0.1.12 | ||
| [v0.1.13]: https://github.com/JuliaDocs/IOCapture.jl/releases/tag/v0.1.13 | ||
| [v0.1.14]: https://github.com/JuliaDocs/IOCapture.jl/releases/tag/v0.1.14 | ||
| [v0.1.15]: https://github.com/JuliaDocs/IOCapture.jl/releases/tag/v0.1.15 | ||
| [v0.1.16]: https://github.com/JuliaDocs/IOCapture.jl/releases/tag/v0.1.16 | ||
| [v0.1.17]: https://github.com/JuliaDocs/IOCapture.jl/releases/tag/v0.1.17 | ||
| [v0.1.18]: https://github.com/JuliaDocs/IOCapture.jl/releases/tag/v0.1.18 | ||
| [v0.1.19]: https://github.com/JuliaDocs/IOCapture.jl/releases/tag/v0.1.19 | ||
| [#21]: https://github.com/JuliaDocs/IOCapture.jl/issues/21 | ||
| [#22]: https://github.com/JuliaDocs/IOCapture.jl/issues/22 | ||
| [#27]: https://github.com/JuliaDocs/IOCapture.jl/issues/27 | ||
| [#30]: https://github.com/JuliaDocs/IOCapture.jl/issues/30 | ||
| [#32]: https://github.com/JuliaDocs/IOCapture.jl/issues/32 | ||
| [#33]: https://github.com/JuliaDocs/IOCapture.jl/issues/33 | ||
| [#35]: https://github.com/JuliaDocs/IOCapture.jl/issues/35 | ||
| [#36]: https://github.com/JuliaDocs/IOCapture.jl/issues/36 | ||
| [#39]: https://github.com/JuliaDocs/IOCapture.jl/issues/39 | ||
| [#40]: https://github.com/JuliaDocs/IOCapture.jl/issues/40 | ||
| [#44]: https://github.com/JuliaDocs/IOCapture.jl/issues/44 | ||
| [#46]: https://github.com/JuliaDocs/IOCapture.jl/issues/46 | ||
| [#48]: https://github.com/JuliaDocs/IOCapture.jl/issues/48 | ||
| [#49]: https://github.com/JuliaDocs/IOCapture.jl/issues/49 | ||
| [#51]: https://github.com/JuliaDocs/IOCapture.jl/issues/51 | ||
| [#52]: https://github.com/JuliaDocs/IOCapture.jl/issues/52 | ||
| [#54]: https://github.com/JuliaDocs/IOCapture.jl/issues/54 | ||
| [#55]: https://github.com/JuliaDocs/IOCapture.jl/issues/55 | ||
| [#56]: https://github.com/JuliaDocs/IOCapture.jl/issues/56 | ||
| [#59]: https://github.com/JuliaDocs/IOCapture.jl/issues/59 | ||
| [#60]: https://github.com/JuliaDocs/IOCapture.jl/issues/60 | ||
| [#64]: https://github.com/JuliaDocs/IOCapture.jl/issues/64 | ||
| [#65]: https://github.com/JuliaDocs/IOCapture.jl/issues/65 | ||
| [#71]: https://github.com/JuliaDocs/IOCapture.jl/issues/71 | ||
| [#80]: https://github.com/JuliaDocs/IOCapture.jl/issues/80 | ||
| [#81]: https://github.com/JuliaDocs/IOCapture.jl/issues/81 | ||
| [#84]: https://github.com/JuliaDocs/IOCapture.jl/issues/84 | ||
| [#85]: https://github.com/JuliaDocs/IOCapture.jl/issues/85 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| JULIA:=julia | ||
|
|
||
| default: help | ||
|
|
||
| docs-instantiate: | ||
| ${JULIA} --project=docs/ -e'import Pkg; Pkg.instantiate()' | ||
|
|
||
| changelog: docs-instantiate | ||
| ${JULIA} --project=docs/ docs/changelog.jl | ||
|
|
||
| test: | ||
| ${JULIA} --project -e 'using Pkg; Pkg.test()' | ||
|
|
||
| help: | ||
| @echo "The following make commands are available:" | ||
| @echo " - make changelog: update all links in CHANGELOG.md's footer" | ||
| @echo " - make test: run the tests" | ||
|
|
||
| .PHONY: default help changelog test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # This file is machine-generated - editing it directly is not advised | ||
|
|
||
| julia_version = "1.10.0" | ||
| manifest_format = "2.0" | ||
| project_hash = "02bca7169ef631f12fab1418e33f74848d3c2a56" | ||
|
|
||
| [[deps.Changelog]] | ||
| git-tree-sha1 = "c417f9a5c9450fffb0d55bf44353739ffe1c1e56" | ||
| uuid = "5217a498-cd5d-4ec6-b8c2-9b85a09b6e3e" | ||
| version = "1.0.0" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| [deps] | ||
| Changelog = "5217a498-cd5d-4ec6-b8c2-9b85a09b6e3e" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| using Changelog | ||
|
|
||
| Changelog.generate( | ||
| Changelog.CommonMark(), | ||
| joinpath(@__DIR__, "..", "CHANGELOG.md"); | ||
| repo = "JuliaDocs/IOCapture.jl", | ||
| ) |