serokell/xrefcheck
1
1
Fork 0
mirror of https://github.com/serokell/xrefcheck.git synced 2024-09-11 21:47:20 +03:00
Code Issues Projects Releases Wiki Activity
95d5bad3cd
xrefcheck/CHANGES.md

110 lines
4.2 KiB
Markdown
Raw Normal View History

Add a changelog, require its maintenance Problem: we are going to release this tool and from that point it would be nice to maintain its changelog. Solution: add a simple CHANGES.md and update PR template.
2020-01-14 20:22:20 +03:00
<!--
[#47] Handle ftp links Problem: Currently we support only http and https links. If there is an `ftp://` link, you will get exception. Solution: Use `ftp-client` to check connection to ftp, see response statuses and check file existence. This produces adding new error types and small refactoring. Provide a test which is separate executable, where we have to pass CLA - ftp host. Co-authored-by: Alexander Bantyev <alexander.bantyev@serokell.io>
2021-07-08 16:22:44 +03:00
- SPDX-FileCopyrightText: 2021 Serokell <https://serokell.io>
Add a changelog, require its maintenance Problem: we are going to release this tool and from that point it would be nice to maintain its changelog. Solution: add a simple CHANGES.md and update PR template.
2020-01-14 20:22:20 +03:00
-
- SPDX-License-Identifier: MPL-2.0
-->
Unreleased
==========
v0.2.1 release
2022-09-23 14:21:30 +03:00
0.2.1
==========
[#99] Support `Retry-After` headers with dates Problem: We currently support obtaining `Retry-After` header values as seconds. However, the http specs state that the header value can be also a date, e.g: `Wed, 21 Oct 2015 07:28:00 GMT`. Solution: Support `Retry-After` headers with dates.
2022-08-01 13:26:56 +03:00
* [#127](https://github.com/serokell/xrefcheck/pull/127)
+ Support `Retry-After` headers with dates.
[#90] Forbid verifying a single file Problem: Verifying a single file using `-r` option missbehaves when there are absolute links present in the file. Since `-r` option expects a directory, we can just forbid verifying a single file. Solution: Fail with an error message when the user tries to specify a file as the repository's root directory.
2022-07-22 15:29:09 +03:00
* [#117](https://github.com/serokell/xrefcheck/pull/117)
+ Forbid verifying a single file using `--root` command line option.
[Chore] Add missing changelog entries
2022-07-22 18:51:28 +03:00
* [#115](https://github.com/serokell/xrefcheck/pull/115)
+ Improved parsing of anchor html tags inside headers.
* [#109](https://github.com/serokell/xrefcheck/pull/109)
+ Fixed bug when prefixing `--ignored` and `--root` paths with `./`
[#81] Add config option for localhost links Problem: Almost all the time we can't validate localhost links, so we just skip them. But to run ftp links tests (#47) we need to refer to localhost. Solution: Add config option whether to ignore localhost links and provide bats tests for this new feature. Co-authored-by: Alexander Bantyev <alexander.bantyev@serokell.io>
2021-08-04 12:21:34 +03:00
* [#85](https://github.com/serokell/xrefcheck/pull/85)
+ Make possible to specify whether ignore localhost links, use
`check-localhost` CLA argument (by default localhost links will not be checked).
[#81] Add config option for protected links Problem: We do not know what to do with protected links, because we cannot check them. So we have two options, assume that these links is valid or not. Solution: Provide config option for user to decide what to do - assume protected links valid or not.
2021-08-04 12:05:38 +03:00
+ Make possible to ignore auth failures (assume 'protected' links
valid), use `ignoreAuthFailures` parameter of config.
[#47] Handle ftp links Problem: Currently we support only http and https links. If there is an `ftp://` link, you will get exception. Solution: Use `ftp-client` to check connection to ftp, see response statuses and check file existence. This produces adding new error types and small refactoring. Provide a test which is separate executable, where we have to pass CLA - ftp host. Co-authored-by: Alexander Bantyev <alexander.bantyev@serokell.io>
2021-07-08 16:22:44 +03:00
* [#66](https://github.com/serokell/xrefcheck/pull/66)
+ Added support for ftp links.
[#74] Detect and handle duplicate links during verification Problem: All the duplicate external links get verified independently, which is wasteful. Solution: Store the verification results in the map. Verify the link once if it hasn't been verified already, and insert the results into the map; alternatively, if the link has been verified before, return the results by retrieving the respective value from the map. The traversal of all the filepath-reference pairs is done via 'forConcurrentlyCaching', which is semantically similar to Control.Concurrent.Async.forConcurrently, except it stores the action results in a map (in our case, we need to store the verification results of only the external references).
2021-10-04 21:58:24 +03:00
* [#74](https://github.com/serokell/xrefcheck/pull/83)
+ Add the duplication detection & verification result caching algorithm for external references.
[#75] Fix the root with an appended slash support Problem: The results of the repository analysis will always contain invalid references if the root contains a trailing forward slash. Solution: Strip the root's trailing slash (if present) when having it be given as an argument of the System.FilePath.Posix.takeDirectory function.
2021-09-07 20:25:32 +03:00
* [#82](https://github.com/serokell/xrefcheck/pull/82)
+ Fix the issue of having the lowest level context duplicated, caused by the root's trailing path separator.
[#49] Allow certain reserved characters in the URLs Problem: The current version of xrefcheck doesn't allow the square brackets and some other special characters, like the angle brackets and the curly brackets, to be present in the URLs, even in the query strings, as they need to be percent-encoded first. Solution: Allow some of the reserved characters, like the brackets, to be present in the query strings of the URLs. There exist two main standards of URL parsing: RFC 3986 and the Web Hypertext Application Technology Working Group's URL standard. Ideally, we want to be able to parse the URLs in accordance with the latter standard, because it provides a much less ambiguous set of rules for percent-encoding special characters, and is essentially a living standard that gets updated constantly. We allow these characters to be present in the query strings by using the `parseURI` function from the `uri-bytestring` library with `laxURIParseOptions`.
2022-07-15 01:10:12 +03:00
* [#88](https://github.com/serokell/xrefcheck/pull/88)
[#31] Handle the "429 too many requests" errors Problem: The current version of xrefcheck handles the HTTP responses with the 429 status code just like every other error, when it is possible to try and eliminate the occurrences of such errors within the program itself. Solution: Each time the result of performing a request on a given link is a 429 error, retrieve the Retry-After information, describing the delay (in seconds), from the headers of the HTTP response, or, alternatively, use a configurable default value if the Retry-After header is absent, and rerun the request after an amount of time described by the said value had passed. Only after the number of retries had reached its limiting value, which, as of right now, is not configurable and is hardcoded, is when the 429 error is converted into becoming 'unfixable', and any further attempts to remove the error are terminated. Additionally, the progress bar has been upgraded and the following elements are supplied: 1. an extra color -- Blue -- indicating the errors that might get eliminated during the verification; 2. a timer with the number of seconds left to wait for the restart of the request; if, during the verification, a new 429 error had emerged with the new Retry-After value being greater than or equal to the elapsed time, the timer is immediately updated with that value and begins ticking down each second from scratch.
2021-10-22 01:00:18 +03:00
+ Handle the "429 too many requests" errors & attempt to eliminate them during verification.
[#126] Changelog update: Make `ignoreRefs` a required parameter Problem: We made `ignoreRefs` a required option. Since this is "user-facing change", we should add an entry to `CHANGES.md`. Solution: Add an entry to `CHANGES.md`.
2022-08-29 10:20:01 +03:00
* [#128](https://github.com/serokell/xrefcheck/pull/128)
+ Make `ignoreRefs` a required parameter.
[#94] Changelog update: Add support for the `id` attribute in anchors Problem: We added support for the `id` attribute in anchors. Since this is "user-facing change", we should add an entry to `CHANGES.md`. Solution: Add an entry to `CHANGES.md`.
2022-08-29 10:46:32 +03:00
* [#129](https://github.com/serokell/xrefcheck/pull/129)
[#49] Allow certain reserved characters in the URLs Problem: The current version of xrefcheck doesn't allow the square brackets and some other special characters, like the angle brackets and the curly brackets, to be present in the URLs, even in the query strings, as they need to be percent-encoded first. Solution: Allow some of the reserved characters, like the brackets, to be present in the query strings of the URLs. There exist two main standards of URL parsing: RFC 3986 and the Web Hypertext Application Technology Working Group's URL standard. Ideally, we want to be able to parse the URLs in accordance with the latter standard, because it provides a much less ambiguous set of rules for percent-encoding special characters, and is essentially a living standard that gets updated constantly. We allow these characters to be present in the query strings by using the `parseURI` function from the `uri-bytestring` library with `laxURIParseOptions`.
2022-07-15 01:10:12 +03:00
+ Add support for the `id` attribute in anchors.
* [#116](https://github.com/serokell/xrefcheck/pull/116)
+ Allow certain reserved characters to be present in the query strings of the URLs.
[#120] Fix bug with ignoring checks for relative anchors Problem: When a file contains a reference to another file, and that reference contains an anchor, that anchor is not checked. Solution: Normalise relative anchor links before check.
2022-08-30 20:05:18 +03:00
* [#130](https://github.com/serokell/xrefcheck/pull/130)
+ Fixed bug with ignoring checks for relative anchors.
[#125] Display URL parsing errors Problem: We use a 2-step process to parse a URL: we use `parseURI` and then `mkURIBs`. Both of these functions can fail. At the moment, we're ignoring their errors and simply throwing a `ExternalResourceInvalidUri`, and then displaying a generic error message to the user. Solution: Catch errors from `parseUri` and `mkURIBs` and use them to tell user why the URL was invalid.
2022-09-07 00:19:17 +03:00
* [#132](https://github.com/serokell/xrefcheck/pull/132)
+ Display URL parsing errors.
[#77] Add support for glob patterns to `ignored` and `notScanned` Problem: The `virtualFiles` config option supports glob patterns. On the other hand, `ignored` only supports exact matches and `notScanned` mathches on prefixes. There is also a bug where `ignored` does not ignore files if they contain broken xrefcheck annotations. Solution: Add support for glob patterns to `ignored` and `notScanned`. Filter ignored files before parsing their contents.
2022-09-03 20:25:02 +03:00
* [#131](https://github.com/serokell/xrefcheck/pull/131)
+ Add support for glob patterns to `ignored` and `notScanned`.
+ Remove support for directory names from `ignored` and `notScanned`.
+ Fix bug with `ignored` not ignoring files with broken xrefcheck annotations.
[#137] Remove `checkLocalhost` option Problem: In #85, we added the `checkLocalhost` option to decide whether to verify links to localhost. However, upon further reflection, it seems like this could have been subsumed by the existing `ignoreRefs` option instead. Solution: Remove `check-localhost` CLI option and `checkLocalhost` config option. Add a regex matching localhost links to the `ignoreRefs` field of the default config.
2022-09-14 13:00:28 +03:00
* [#142](https://github.com/serokell/xrefcheck/pull/142)
+ Remove `check-localhost` CLI option and `checkLocalhost` config option.
+ Add a regex matching localhost links to the `ignoreRefs` field of the default config.
[#62] [INT-141] Add to changelog, update version
2021-07-13 20:17:22 +03:00
* [#68](https://github.com/serokell/xrefcheck/pull/68)
+ Recognise manual HTML-anchors inside headers.
[#56] Dump all the errors from different files Problem: Currently, xrefcheck fails immediately after the first observed error because `die` is used right in `markdownScanner` What we want is dumping all the errors from different markdowns and then print them as a final xrefcheck's result together with the broken links. Also, despite the fact that in the `makeError` function we have 4 error messages, 2 of them are not reported, and the test case that should check this only checks that at least one of the four files throws an error. Solution: Make xrefcheck to report all errors. Add `ScanError` type and propagate errors to report all of them, rather than failing immediately after the first error is detected.
2022-09-08 22:17:27 +03:00
* [#141](https://github.com/serokell/xrefcheck/pull/141)
+ Dump all the errors from different files.
+ Fix bug where no errors were reported about broken link annotation and unrecognised annotation.
[#156] Make all config options optional Problem: In #126 we made the `ignoreRefs` option required (to match the other options). However, having it optional is better for backwards-compatibility and to help users migrate to newer xrefcheck versions. Solution: Make all config options optional.
2022-09-23 22:51:39 +03:00
* [#159](https://github.com/serokell/xrefcheck/pull/159)
+ Make all config options optional.
[#62] [INT-141] Add to changelog, update version
2021-07-13 20:17:22 +03:00
Make 0.2 release
2021-05-04 15:51:28 +03:00
0.2
==========
v0.2.1 release
2022-09-23 14:21:30 +03:00
Update changelog
2021-02-25 20:09:17 +03:00
* [#57](https://github.com/serokell/xrefcheck/pull/57)
+ Added `flavor` field to config.
Also see [config sample](tests/configs/github-config.yaml).
+ Config generated with `dump-config` CLI command now depends on the provided repository type.
Prepare 0.1.3 release Problem: the feature with ignoring links has been added, and it is necessary in many places. Solution: make a release.
2021-03-17 15:02:49 +03:00
0.1.3
=======
* [#58](https://github.com/serokell/xrefcheck/pull/58)
+ Switch to lts-17.3.
[#135] Add "ignoring" changes to `CHANGES.md` Problem: Changes connected with adding `ignoreRefs` and ignorong modes are not stated in `CHANGES.md` Solution: Add information about such changes.
2020-12-25 17:23:29 +03:00
* [#53](https://github.com/serokell/xrefcheck/pull/53)
+ Make possible to include a regular expression in
`ignoreRefs` parameter of config to ignore external
references.
+ Add support of right in-place ignoring annotations
such as `ignore file`, `ignore paragraph` and `ignore link`.
Make a release
2020-06-26 15:41:52 +03:00
0.1.2
=======
Disable progress bar in CI automatically Problem: we have two major use cases: 1. Using xrefcheck in CI, in this case it is annoying for devops to always pass mostly always reasonable `--no-progress` option. 2. Using it locally, here we want progress bar to be enabled by default so that user could run `xrefcheck` without any options most of the time. Solution: Detect whether are we running in CI and use the respective default for whether progress bar should be displayed. Detecting whether we are within CI is possible using `CI` env variable, at least Github actions, Gitlab CI and Buildkite pass this env. `--no-progress` option still can be passed if user wants to suppress progress bar in local run. The opposite `--progress` seems to also make sense, because in case if high timeouts are set, user probably wants to track progress somehow to make sure that CI didn't hang. So we add the latter, and these two options can be used to override the default behaviour defined by `CI` env var.
2020-06-26 10:48:12 +03:00
* [#44](https://github.com/serokell/xrefcheck/pull/44)
+ Decide whether to show progress bar by default depending on `CI` env variable.
+ Added `--progress` option.
Update version and changelog Hopefully with recent changes Hackage will finally manage to build this package, so let's try uploading again.
2020-05-19 21:15:51 +03:00
0.1.1.2
=======
* [#34](https://github.com/serokell/xrefcheck/pull/34)
+ Do not depend on `autoexporter` and `base-noprelude`.
Make a new release This should fix the build problems on Hackage.
2020-05-15 21:00:52 +03:00
0.1.1.1
=======
* [#30](https://github.com/serokell/xrefcheck/pull/32)
+ Do not depend on `loot-prelude` package.
Bump version to 0.1.1
2020-04-25 18:41:39 +03:00
0.1.1
=======
Update changelog
2020-04-25 18:40:49 +03:00
* [#19](https://github.com/serokell/xrefcheck/pull/24)
+ Make `ignored` in config consider only exact matches.
+ Improve virtual files consideration.
+ Add `ignored` CLI option.
Add a changelog, require its maintenance Problem: we are going to release this tool and from that point it would be nice to maintain its changelog. Solution: add a simple CHANGES.md and update PR template.
2020-01-14 20:22:20 +03:00
0.1.0.0
=======
Initial release.
Reference in New Issue Copy Permalink