Skip to content

CHANGELOG.md

Latest commit

 

History

History
200 lines (132 loc) · 8.6 KB

CHANGELOG.md

File metadata and controls

200 lines (132 loc) · 8.6 KB
Raw

Change Log

All notable changes to this project will be documented in this file. The format is based on Keep a Changelog.

v1.7.0 - UNRELEASED

Important

The mirror at https://gitlab.com/nodiscc/hecat will no longer be maintained after this release.
Please use https://github.com/nodiscc/xsrv instead

Added:

  • processors/archive_webpages: add wget_quiet: False/True option to silence wget output
  • processors/download_media: add max_resolution option to cap video download resolution (default 1080)

Changed:

  • BREAKING: archive gitlab.com mirror

Fixed:

  • processors/url_check: handle InvalidURL exceptions

v1.6.0 - 2026-03-22

Added:

  • processors/software_metadata: add support for Gitlab metadata
  • processors/archive_webpages: add wget_errors_are_fatal: False module option
  • processors/download_media: add abort_on_first_error: False (stop on download failures if True)
  • processors/archive_webpages: log reasons for skipping items and removing local archive directories

Changed:

  • BREAKING: rename processors/github_metadata to processors/software_metadata
  • BREAKING: rename gh_metadata_only_missing module option to metadata_only_missing
  • processors/archive_webpages: improve performance, do not perform unnecessary searches/comparisons
  • processors/archive_webpages: refactoring, separation of concerns, readability
  • processors/download_media: retry download up to 3 times in case of 403 error
  • processors/download_media: limit video downloads to 1080p resolution

Fixed:

  • processors/software_metadata: fixes invalid GitHub URLs/deleted repositories not being reported
  • processors/software_metadata: fix issue where GitHub repos that were forks did not get updated
  • processors/archive_webpages: fix clean_excluded: True not really deleting webpage archives for items whose URLs/tags match exclude_regex/exclude tags
  • processors/archive_webpages: fix undefined variable in local webpage archive found with id N, but not in data log message
  • processors/archive_webpages: actually write changes/removal of archive_path key to the data file
  • processors/archive_webpages: doc: any intersection between only_tags and the item's tags will actually cause it to be archived
  • processors/archive_webpages: do not assume only_tags is always set

v1.5.1 - 2025-11-29

Fixed:

  • processors/github_metadata: match repos by full owner/name path, prevents wrong metadata when 2 projects have the same name

v1.5.0 - 2025-10-23

Changed:

  • processors/github_metadata: use GraphQL instad of REST API
  • processors/github_metadata: add new additional metadata keys commit_history, current_release
  • processors/github_metadata: new module options batch_size, commit_history_clean_months, commit_history_fetch_months with default values

Fixed:

  • fix failing tests when make test_archive_webpages is run from Github Actions

v1.4.0 - 2025-03-29

Added:

  • processors/archive_webpages: allow excluding URLs using exclude_regex: URL_REGEX
  • processors/archive_webpages: allow removing already existing local archives of excluded URLs (clean_excluded: False/True)

Fixed:

  • processors/url_check: handle TooManyRedirects exception

v1.3.1 - 2024-12-29

Fixed:

  • utils: to_kebab_case(): trim characters from filenames, which are invalid on MS Windows

v1.3.0 - 2024-12-26

Added:

  • add archive_webpages processor (download local copies of webpages linked in the url key of items)
  • processors/awesome_lint: check that filenames in software/* match the kebab-case version of the name: attribute inside each file
  • processors/awesome_lint: make the list of required fields/attributes for platforms configurable through platforms_required_fields module option (default to ['description'])

Changed:

  • processors/awesome_lint: check that depends_3rdparty is a valid boolean value (true/false/True/False)
  • exporters/html_table: add a column displaying a link to a local archive of the page, if it exists (as generated by processors/archive_webpages), write a warning symbol to this column when page archival failed
  • exporters/html_table: automatically create links from URLs
  • exporters/html_table: constrain title/description column width between 480px and 900px
  • exporters/html_table: reorder columns
  • update documentation

Fixed:

  • html_table: fix fenced code blocks formatting

v1.2.2 - 2023-11-03

Changed:

  • processors/github_metadata: use git commit date instead of author date

v1.2.1 - 2023-10-27

Added:

  • processors/awesome_lint: allow skipping last update checks for specific items by source_code_url

Fixed:

  • exporters/markdown_multipage: URL encode links href in literal HTML blocks
  • processors/awesome_lint: don't log last update date check errors twice

v1.2.0 - 2023-10-10

Added:

  • exporters/markdown_multipage: render subpages for each platform

Changed:

  • exporters/markdown_multipage: move CSS styles to external CSS file. html_css_files = ['custom.css'] is now required in sphinx configuration file
  • processors/awesome_lint: check that platforms in software items exist in the main platforms list
  • processors/awesome_lint: check that platform items have a non-empty description attribute
  • exporters/markdown_multipage: prevent platforms pages from showing up in sphinx search results

Fixed:

  • exporters/markdown_multipage: fix spacing around tag spans

v1.1.3 - 2023-09-19

Fixed:

  • exporters/markdown_multipage: fix spacing/newlines before/between/after Clients and Demo links

v1.1.2 - 2023-09-19

Changed:

  • processors/awesome_lint: run checks on tag items before checks on software items

Fixed:

  • processors/awesome_lint: fix detection of redirect attribute when a tag has least than N items
  • processors/awesome_lint: if items_in_redirect_fatal: True (the default), fail if any software item references a tag with redirect: set/not empty
  • processors/awesome_lint: fail if any tag item has less than 3 software items referencing it, unless its redirect attribute is set/not empty
  • exporters/markdown_multipage: render Demo link for software items where demo_url is set

v1.1.1 - 2023-08-19

Fixed:

  • processors/awesome_lint: fix displayed number of days in older than ... days for error-level messages
  • processors/github_metadata: don't split long lines in YAML output

v1.1.0 - 2023-07-29

Added:

  • processors/awesome_lint: allow confguring the number of days without updates to a project before triggering an info/warning/error message (last_updated_{error,warn,info}_days, default to 3650, 365, 186 respectively)

v1.0.2 - 2023-07-27

Changed:

  • dependencies: upgrade sphinx to v7.1.0, pin furo to v2023.7.26

Fixed:

  • doc/tests: don't use deprecated python3 setup.py install, use python3 -m pip install .
  • dependencies: install sphinx through install_requires, separate manual installation step is no longer required

v1.0.1 - 2023-07-24

Changed:

  • utils: to_kebab_case(): replace : character with - (avoids filename issues on NTFS, consistent with automatic anchor generation)

v1.0.0 - 2023-07-24

Initial release, see README.md and module-specific documentation in each module's docstring.