2020-01-14 20:22:20 +03:00
|
|
|
<!--
|
2021-07-08 16:22:44 +03:00
|
|
|
- SPDX-FileCopyrightText: 2021 Serokell <https://serokell.io>
|
2020-01-14 20:22:20 +03:00
|
|
|
-
|
|
|
|
- SPDX-License-Identifier: MPL-2.0
|
|
|
|
-->
|
|
|
|
|
|
|
|
Unreleased
|
|
|
|
==========
|
2022-10-25 12:27:27 +03:00
|
|
|
|
2022-09-28 12:52:32 +03:00
|
|
|
* [#176](https://github.com/serokell/xrefcheck/pull/176)
|
|
|
|
+ Enabled `autolink` extension for `cmark-gfm`, so now we're finding strings
|
2022-12-19 19:50:07 +03:00
|
|
|
like `www.google.com` or `https://google.com`, treating them as links
|
|
|
|
and checking.
|
2022-09-27 10:30:24 +03:00
|
|
|
* [#175](https://github.com/serokell/xrefcheck/pull/175)
|
|
|
|
+ Reorganize top-level config keys.
|
2022-09-28 11:04:08 +03:00
|
|
|
* [#178](https://github.com/serokell/xrefcheck/pull/178)
|
|
|
|
+ Rename exclusion-related config options.
|
2022-09-29 12:11:42 +03:00
|
|
|
* [#183](https://github.com/serokell/xrefcheck/pull/183)
|
|
|
|
+ Add support for image links.
|
2022-10-26 13:30:47 +03:00
|
|
|
* [#199](https://github.com/serokell/xrefcheck/pull/199)
|
|
|
|
+ Now annotation
|
2022-12-19 19:50:07 +03:00
|
|
|
`<!-- xrefcheck: ignore all -->` instead of `<!-- xrefcheck: ignore file -->`
|
|
|
|
should be used to disable checking for links in file, so it's clearer that
|
|
|
|
file itself is not ignored (and links can target it).
|
2022-11-16 01:52:43 +03:00
|
|
|
* [#215](https://github.com/serokell/xrefcheck/pull/215)
|
|
|
|
+ Now we notify user when there are scannable files that were not added to Git
|
2022-12-19 19:50:07 +03:00
|
|
|
yet. Also added CLI option `--include-untracked` to scan such files and treat
|
|
|
|
as existing.
|
2022-10-13 17:07:19 +03:00
|
|
|
* [#191](https://github.com/serokell/xrefcheck/pull/191)
|
|
|
|
+ Now we consider slash `/` (and only it) as path separator in local links for all OS,
|
|
|
|
so xrefcheck's report is OS-independent
|
|
|
|
+ Use utf-8 compatible codepage on Windows
|
2022-11-29 13:16:56 +03:00
|
|
|
* [#224](https://github.com/serokell/xrefcheck/pull/224)
|
|
|
|
+ Now the program output does not contain unicode characters that are not widely supported.
|
2022-12-01 14:00:49 +03:00
|
|
|
* [#229](https://github.com/serokell/xrefcheck/pull/229)
|
2022-12-01 13:54:32 +03:00
|
|
|
+ Now we call references to anchors in current file (e.g. `[a](#b)`) as
|
|
|
|
`file-local` references instead of calling them `current file` (which was ambiguous).
|
2022-12-07 17:48:09 +03:00
|
|
|
* [#233](https://github.com/serokell/xrefcheck/pull/233)
|
|
|
|
+ Now xrefxcheck does not follow redirect links by default. It fails for permanent
|
|
|
|
redirect responses (i.e. 301 and 308) and passes for temporary ones (i.e. 302, 303, 307).
|
2022-12-13 12:20:32 +03:00
|
|
|
* [#231](https://github.com/serokell/xrefcheck/pull/231)
|
|
|
|
+ Anchor analysis takes now into account the appropriate case-sensitivity depending on
|
2022-12-19 19:50:07 +03:00
|
|
|
the configured Markdown flavour.
|
2022-12-22 15:20:05 +03:00
|
|
|
* [#254](https://github.com/serokell/xrefcheck/pull/254)
|
|
|
|
+ Now the `dump-config` command does not overwrite a file unless explicitly told with a
|
|
|
|
`--force` flag. Also, a `--stdout` flag allows to print the config to stdout instead.
|
2022-12-19 19:50:07 +03:00
|
|
|
* [#250](https://github.com/serokell/xrefcheck/pull/250)
|
|
|
|
+ Now the redirect behavior for external references can be modified via rules in the
|
|
|
|
configuration file with the `externalRefRedirects` parameter.
|
2023-01-12 22:12:43 +03:00
|
|
|
* [#261](https://github.com/serokell/xrefcheck/pull/261)
|
|
|
|
+ Symlinks are now not processed by the scanner.
|
2023-01-19 21:58:12 +03:00
|
|
|
* [#268](https://github.com/serokell/xrefcheck/pull/268)
|
|
|
|
+ Added CLI option `--color` that enables ANSI colors in output.
|
|
|
|
+ Changed the output coloring defaults to show colors when `CI` env variable is `true`.
|
2023-01-26 13:35:57 +03:00
|
|
|
* [#271](https://github.com/serokell/xrefcheck/pull/271)
|
|
|
|
+ Now Xrefcheck is able to follow relative redirects.
|
2022-12-30 20:37:37 +03:00
|
|
|
* [#262](https://github.com/serokell/xrefcheck/pull/262)
|
|
|
|
+ Now Xrefcheck includes a scanner that verifies the repository symlinks.
|
2022-09-28 12:52:32 +03:00
|
|
|
|
2022-10-25 12:27:27 +03:00
|
|
|
0.2.2
|
|
|
|
==========
|
|
|
|
|
2022-09-25 20:03:57 +03:00
|
|
|
* [#145](https://github.com/serokell/xrefcheck/pull/145)
|
|
|
|
+ Add check that there is no unknown fields in config.
|
2022-09-23 17:55:49 +03:00
|
|
|
* [#158](https://github.com/serokell/xrefcheck/pull/158)
|
2022-09-27 10:30:24 +03:00
|
|
|
+ Fixed bug when we reported footnotes as broken links.
|
2022-09-24 18:50:29 +03:00
|
|
|
* [#163](https://github.com/serokell/xrefcheck/pull/163)
|
|
|
|
+ Fixed an issue where the progress bar thread might be unexpectedly cancelled and jumble up the output.
|
2022-09-29 12:56:05 +03:00
|
|
|
* [#184](https://github.com/serokell/xrefcheck/pull/184)
|
|
|
|
+ Make `flavor` a required parameter.
|
2022-09-28 21:58:17 +03:00
|
|
|
* [#182](https://github.com/serokell/xrefcheck/pull/182)
|
|
|
|
+ Now we call references to anchors in current file (e.g. `[a](#b)`) as
|
2022-12-01 13:54:32 +03:00
|
|
|
`current file` references instead of calling them `local` (which was ambiguous).
|
2022-10-01 20:28:44 +03:00
|
|
|
* [#188](https://github.com/serokell/xrefcheck/pull/188)
|
|
|
|
+ Added CLI option `--no-colors` that disables ANSI colors in output.
|
2022-10-01 20:29:20 +03:00
|
|
|
+ Automatically disable coloring if it is not supported
|
2022-09-19 12:40:37 +03:00
|
|
|
* [#152](https://github.com/serokell/xrefcheck/pull/152)
|
|
|
|
+ Now we report links that target a file outside repository (e.g. `/../a.md`)
|
|
|
|
as broken (with message `Link targets a local file outside repository`).
|
|
|
|
Same for links that are using directories outside repository (e.g. `/../repo/a.md`),
|
|
|
|
since such things are not supported by GitHub markdown renderer.
|
2022-09-26 08:34:13 +03:00
|
|
|
* [#174](https://github.com/serokell/xrefcheck/pull/174)
|
|
|
|
+ Make xrefcheck only scan files that are tracked by git.
|
|
|
|
+ Fixed bug where links to ignored files were valid.
|
|
|
|
+ Fixed bug where links with trailing slashes were invalid.
|
2022-10-18 23:15:40 +03:00
|
|
|
* [#198](https://github.com/serokell/xrefcheck/pull/198)
|
|
|
|
+ Now we're checking globs in config fields and CLI args (e.g. `ignored`),
|
|
|
|
they must be valid globs relative to repository root (`foo/*` instead of `/foo/*`)
|
2022-10-18 00:47:18 +03:00
|
|
|
* [#196](https://github.com/serokell/xrefcheck/pull/196)
|
|
|
|
+ Now `xrefcheck: ignore link` annotation expects a link to ignore in next markdown node,
|
|
|
|
instead of expecting link in whole rest of file.
|
|
|
|
If you've got `Expected a LINK after "ignore link" annotation` message, see
|
|
|
|
PR's description for examples and details.
|
2022-09-19 12:40:37 +03:00
|
|
|
|
2022-09-23 14:21:30 +03:00
|
|
|
0.2.1
|
|
|
|
==========
|
|
|
|
|
2022-08-01 13:26:56 +03:00
|
|
|
* [#127](https://github.com/serokell/xrefcheck/pull/127)
|
|
|
|
+ Support `Retry-After` headers with dates.
|
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.
|
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 `./`
|
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).
|
2021-08-04 12:05:38 +03:00
|
|
|
+ Make possible to ignore auth failures (assume 'protected' links
|
2022-12-19 19:50:07 +03:00
|
|
|
valid), use `ignoreAuthFailures` parameter of config.
|
2021-07-08 16:22:44 +03:00
|
|
|
* [#66](https://github.com/serokell/xrefcheck/pull/66)
|
|
|
|
+ Added support for ftp links.
|
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.
|
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.
|
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.
|
2022-08-29 10:20:01 +03:00
|
|
|
* [#128](https://github.com/serokell/xrefcheck/pull/128)
|
|
|
|
+ Make `ignoreRefs` a required parameter.
|
2022-08-29 10:46:32 +03:00
|
|
|
* [#129](https://github.com/serokell/xrefcheck/pull/129)
|
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.
|
2022-08-30 20:05:18 +03:00
|
|
|
* [#130](https://github.com/serokell/xrefcheck/pull/130)
|
|
|
|
+ Fixed bug with ignoring checks for relative anchors.
|
2022-09-07 00:19:17 +03:00
|
|
|
* [#132](https://github.com/serokell/xrefcheck/pull/132)
|
|
|
|
+ Display URL parsing errors.
|
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.
|
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.
|
2021-07-13 20:17:22 +03:00
|
|
|
* [#68](https://github.com/serokell/xrefcheck/pull/68)
|
|
|
|
+ Recognise manual HTML-anchors inside headers.
|
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.
|
2022-09-23 22:51:39 +03:00
|
|
|
* [#159](https://github.com/serokell/xrefcheck/pull/159)
|
|
|
|
+ Make all config options optional.
|
2021-07-13 20:17:22 +03:00
|
|
|
|
2021-05-04 15:51:28 +03:00
|
|
|
0.2
|
|
|
|
==========
|
2022-09-23 14:21:30 +03:00
|
|
|
|
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.
|
2021-03-17 15:02:49 +03:00
|
|
|
|
|
|
|
0.1.3
|
|
|
|
=======
|
|
|
|
|
|
|
|
* [#58](https://github.com/serokell/xrefcheck/pull/58)
|
|
|
|
+ Switch to lts-17.3.
|
2020-12-25 17:23:29 +03:00
|
|
|
* [#53](https://github.com/serokell/xrefcheck/pull/53)
|
|
|
|
+ Make possible to include a regular expression in
|
2022-12-19 19:50:07 +03:00
|
|
|
`ignoreRefs` parameter of config to ignore external
|
|
|
|
references.
|
2020-12-25 17:23:29 +03:00
|
|
|
+ Add support of right in-place ignoring annotations
|
2022-12-19 19:50:07 +03:00
|
|
|
such as `ignore file`, `ignore paragraph` and `ignore link`.
|
2020-12-25 17:23:29 +03:00
|
|
|
|
2020-06-26 15:41:52 +03:00
|
|
|
0.1.2
|
|
|
|
=======
|
|
|
|
|
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.
|
|
|
|
|
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`.
|
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.
|
|
|
|
|
2020-04-25 18:41:39 +03:00
|
|
|
0.1.1
|
|
|
|
=======
|
|
|
|
|
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.
|
|
|
|
|
2020-01-14 20:22:20 +03:00
|
|
|
0.1.0.0
|
|
|
|
=======
|
|
|
|
|
|
|
|
Initial release.
|