From 56394df2f197f966dddffcbfb8127c0c71547cdc Mon Sep 17 00:00:00 2001 From: Mattt Date: Wed, 8 Apr 2020 08:18:37 -0700 Subject: [PATCH 1/2] Add Changelog.md --- Changelog.md | 164 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 164 insertions(+) create mode 100644 Changelog.md diff --git a/Changelog.md b/Changelog.md new file mode 100644 index 00000000..12341f22 --- /dev/null +++ b/Changelog.md @@ -0,0 +1,164 @@ +# 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.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Changed + +- **Breaking Change** + Changed the SwiftDoc GitHub Action to require a secret named + `GH_PERSONAL_ACCESS_TOKEN` (previously `GITHUB_PERSONAL_ACCESS_TOKEN`). + According to the GitHub Help article + ["Creating and storing encrypted secrets"](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets): + > Secret names cannot include any spaces or start with the `GITHUB_` prefix. + > 8837d82 by @mattt. +- **Breaking Change** + Changed the SwiftDoc GitHub Action to require a `module-name` parameter + and accepts a `format` parameter. + b231c07 by @mattt. +- Changed output for CommonMark format to omit Home page + for output with only a single page. + #55 by @mattt. +- Changed output for CommonMark format to nest sections in Members component. + #55 by @mattt. +- Changed output for CommonMark format to remove initializer clauses + from variable and enumeration case declarations. + #55 by @mattt. +- Changed CI tests to build and run with a `release` configuration + for consistency with the executable built with `make install`. + #51 by @mattt. +- Changed use of `print` statements, + replacing them with a formal logging infrastructure. + #52 by @mattt. + +### Fixed + +- Fixed bug in `SourceFile.Visitor` that caused incorrect results + when determining the context of symbols parsed from Swift source files. + #51 by @mattt. +- Fixed SwiftDoc GitHub action to build against latest version of `swift-doc`. + 5c0e4e0 by @mattt +- Fixed output for CommonMark format to escape GitHub Emoji shortcodes + #55 by @mattt. +- Fixed output for CommonMark format to remove duplicate headings + for global symbol pages. + #55 by @mattt. +- Fixed documentation for SwiftDoc GitHub Action + to clarify that only a single path can be specified for the `input` parameter. + c34ccc1 by @mattt (#19). +- Fixed `coverage` subcommand description. + #16 by @rastersize. + +## [1.0.0-beta.1] - 2020-04-01 + +### Added + +- Added HTML output format. + #21 by @mattt. + +### Changed + +- **Breaking Change** + Changed minimum Swift version requirements to 5.2 or later. + #21 by @mattt. +- Changed command-line interface to provide functionality through subcommands. + #21 by @mattt. +- Changed `Package.swift` to add `swift-doc` executable and `SwiftDoc` library + to the list of package products. + #21 by @mattt. + +## [0.1.1] - 2020-03-30 + +### Changed + +- Changed documentation workflow to use `github-wiki-publish-action@v1`. + 4525b8e by @mattt. + +## [0.1.0] - 2020-03-28 + +### Added + +- Added initial test suite for `SwiftDoc` target. + #17 by @mattt. + +### Changed + +- Changed command-line interface to use `swift-argument-parser`. + #20 by @mattt. + +### Fixed + +- Fixed treatment of members of public protocol to be considered public symbols. + #17 by @mattt. + +### Removed + +- Removed `api-inventory` subcommand. + (This functionality can now be found in its own repository: + https://github.com/SwiftDocOrg/swift-api-inventory) + #17 by @mattt. + +## [0.0.4] - 2020-03-10 + +### Changed + +- Changed `Package.swift` to include `SwiftDoc` library product in manifest. + f852a14 by @mattt. +- Changed documentation workflow to generate docs for `SwiftDoc` sources only. + da04436 by @mattt. + +### Fixed + +- Fixed generation to return symbols in consistent order. + 97b2347 by @mattt. +- Fixed how enumeration cases are considered to have public access level. + 774faf6 by @mattt. + +## [0.0.3] - 2020-02-13 + +### Added + +- Added CI workflow. + ce40367 by @mattt. +- Added documentation workflow. + a47f178 by @mattt. + +### Changed + +- Changed documentation generation to filter non-public symbols. + 3af57a6 by @mattt. + +## [0.0.2] - 2020-02-06 + +### Added + +- Added "Installation" section to README. + 7784bef by @mattt. +- Added experimental `swift-api-diagram` executable. + 017e920 by @mattt. + +### Fixed + +- Fixed division by zero when calculating documentation coverage. + #5 by @mattt. +- Fixed treatment of directories with `.swift` suffix. + #14 by @mattt. +- Fixed errors in README. + #4 by @Dinsen. + #6 by @HeEAaD. + #10 by @morqon + +## [0.0.1] - 2020-01-27 + +Initial release. + +[unreleased]: https://github.com/SwiftDocOrg/swift-doc/compare/1.0.0-beta.1...master +[1.0.0-beta.1]: https://github.com/SwiftDocOrg/swift-doc/releases/tag/1.0.0-beta.1 +[0.1.1]: https://github.com/SwiftDocOrg/swift-doc/releases/tag/0.1.1 +[0.1.0]: https://github.com/SwiftDocOrg/swift-doc/releases/tag/0.1.0 +[0.0.4]: https://github.com/SwiftDocOrg/swift-doc/releases/tag/0.0.4 +[0.0.3]: https://github.com/SwiftDocOrg/swift-doc/releases/tag/0.0.3 From b7e84423fa496ae77d181710433f488358575366 Mon Sep 17 00:00:00 2001 From: Mattt Date: Wed, 8 Apr 2020 08:21:02 -0700 Subject: [PATCH 2/2] Add missing link references to earlier tags --- Changelog.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Changelog.md b/Changelog.md index 12341f22..a72a8d97 100644 --- a/Changelog.md +++ b/Changelog.md @@ -162,3 +162,5 @@ Initial release. [0.1.0]: https://github.com/SwiftDocOrg/swift-doc/releases/tag/0.1.0 [0.0.4]: https://github.com/SwiftDocOrg/swift-doc/releases/tag/0.0.4 [0.0.3]: https://github.com/SwiftDocOrg/swift-doc/releases/tag/0.0.3 +[0.0.2]: https://github.com/SwiftDocOrg/swift-doc/releases/tag/0.0.2 +[0.0.1]: https://github.com/SwiftDocOrg/swift-doc/releases/tag/0.0.1