Skip to content

Releases: sscpac/statick-md

v0.3.1

20 Jan 19:02
4dd5a6f
Compare
Choose a tag to compare
Update version and changelog to 0.3.1. (#75)

v0.3.0

20 Jan 15:48
27b1773
Compare
Choose a tag to compare

Added

  • Support for Python 3.12 and 3.13.
  • Use of pyproject.toml instead of setup.py and requirements.txt.
  • Supports new plugin discovery mechanism for the main Statick tool.

Changed

  • Disabled code coverage requirements in CI for now.
    • Unable to get line coverage working with new plugin mechanism. Unit tests still work to find problems.
  • Updated README to use more modern approach to installing Python and NPM packages.
  • Rename plugin modules so they are shorter and less redundant.

Removed

  • No longer support Python 3.8.
  • Proselint tool removed.
    • Unable to resolve type hint and unit test issues. Tool not used as far as Statick developers are aware.

v0.2.0

03 Jan 19:01
a4290ea
Compare
Choose a tag to compare

Removed

  • Removed support for Python 3.7.
  • Removed use of flake8 for unit tests.

v0.1.3

25 Apr 02:25
861b00a
Compare
Choose a tag to compare

Changed

  • Updated publish workflow runner to Ubuntu 22.04 since 18.04 is removed. (#67)

v0.1.2

24 Apr 22:51
654ad51
Compare
Choose a tag to compare

Using current fixes of running tools against all files at once instead of one file at a time on the
https://github.com/github/opensource.guide repository finds 238 Markdown files and shows significant decrease in
execution time.

INFO:root:Scanning package opensource.guide (/home/user/src/opensource.guide) at level documentation
INFO:root:---Discovery---
INFO:root:Running markdown discovery plugin...
INFO:root:  299 markdown files found.
INFO:root:  After filtering, 238 markdown files will be scanned.
INFO:root:markdown discovery plugin done.
package name plugin_type duration (main) duration (unreleased)
opensource.guide find files Discovery 4.9255 4.9149
opensource.guide markdown Discovery 0.0088 0.0086
opensource.guide markdownlint Tool 28.0523 0.8511
opensource.guide print_to_console Reporting 0.4227 0.3386
Overall 34.5287 7.2445

Testing the rstcheck tool plugin against the https://github.com/PointCloudLibrary/blog repository shows
improvements for scanning all files at once.
Statick discovered 353 rst files in this repository.

package name plugin_type duration (main) duration (unreleased)
pcl_blog find files Discovery 5.9150 5.9158
pcl_blog markdown Discovery 0.0033 0.0026
pcl_blog rst Discovery 0.0090 0.0083
pcl_blog markdownlint Tool 0.0994 0.1017
pcl_blog rstcheck Tool 114.8899 0.4774
pcl_blog print_to_console Reporting 0.0021 0.0017
Overall 121.0291 6.6186

(Note that this testing was done with a local fix in the Statick exceptions module for a UnicodeDecodeError.
That fix will get pushed to Statick in the future.)

Added

  • Process all source files at once with tools that support passing in a list of files, instead of invoking each tool
    per file. (#63)
  • Ubuntu 22.04 used in continuous integration workflows. (#62)
  • Python 3.11 used in continuous integration workflows. (#62)

Changed

  • Update GitHub Actions to use latest versions. (#62)

Fixed

  • Ensuring that "Cannot find module" thrown errors from nodejs in markdownlint tool plugin cause statick to error. (#64)

Removed

v0.1.1

10 Oct 21:08
4ea64fd
Compare
Choose a tag to compare

Changed

v0.1.0

04 Jan 19:26
283def7
Compare
Choose a tag to compare

Removed

v0.0.10

04 Jan 17:05
80ecaef
Compare
Choose a tag to compare

Added

  • Add Python 3.10 support. (Thomas Denewiler, @tdenewiler, #48)
  • Add weekly tests and a manual trigger to the test workflow.
  • Switch testing environment from macos-latest to macos-10.15.
    This is to retain support for Python 3.6. (Thomas Denewiler, @tdenewiler, #46)

Fixed

  • Switch use of codecov-action from v1 to v2 for increased stability when uploading reports.
    (Thomas Denewiler, @tdenewiler, #45)
  • Use quotes for version numbers in YAML to avoid truncating trailing zeros. (Thomas Denewiler, @tdenewiler, #48)
  • Fix proselint tests by changing exclamation point to a period in test Markdown files. (Thomas Denewiler, @tdenewiler, #50)

v0.0.9

08 Sep 21:37
0a3fb72
Compare
Choose a tag to compare

Added

Fixed

  • Specifying an encoding when calling open (pylint: W1514).

v0.0.8

28 May 22:24
92cd9d5
Compare
Choose a tag to compare

Changed

  • Switch type hints from comment style to inline style.
  • Renaming plugin directories to match Statick's directory structure.
  • Upgraded version of markdownlint-cli used in Actions to the latest available.
  • For testing with Actions, the installed version of Node was upgraded from v10 to v14.
    Node v10 is no longer supported.
    Node v14 is recommended by the developers as it is a long-term support (LTS) release.

Removed

  • Remove testing support for Ubuntu 16.04 and Python 3.5.
    There is no guarantee Statick will work in those environments any longer.