From 190b37bcc4bdbc09bc40c815f335ac1d3a7a874c Mon Sep 17 00:00:00 2001 From: Stanislav Pankevich Date: Sun, 26 Nov 2023 19:13:22 +0100 Subject: [PATCH 1/6] Regenerate CHANGELOG --- CHANGELOG.md | 63 ++++++++++++++++++++++++++++++++++------------------ 1 file changed, 42 insertions(+), 21 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e29b002..9e28fd3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,14 +1,38 @@ # Changelog -## [Unreleased](https://github.com/mull-project/FileCheck.py/tree/HEAD) +## [v0.0.24](https://github.com/mull-project/FileCheck.py/tree/v0.0.24) (2023-11-26) -[Full Changelog](https://github.com/mull-project/FileCheck.py/compare/v0.0.21...HEAD) +[Full Changelog](https://github.com/mull-project/FileCheck.py/compare/v0.0.23...v0.0.24) **Merged pull requests:** +- Bump version to 0.0.24 [\#200](https://github.com/mull-project/FileCheck.py/pull/200) ([stanislaw](https://github.com/stanislaw)) +- tasks: release task [\#199](https://github.com/mull-project/FileCheck.py/pull/199) ([stanislaw](https://github.com/stanislaw)) +- CI: Add 3.13-dev [\#198](https://github.com/mull-project/FileCheck.py/pull/198) ([stanislaw](https://github.com/stanislaw)) +- Pass count as keyword argument to re.sub\(\) [\#197](https://github.com/mull-project/FileCheck.py/pull/197) ([stanislaw](https://github.com/stanislaw)) +- CI: add Python 3.12 [\#196](https://github.com/mull-project/FileCheck.py/pull/196) ([stanislaw](https://github.com/stanislaw)) +- pyproject.toml: remove Poetry [\#195](https://github.com/mull-project/FileCheck.py/pull/195) ([stanislaw](https://github.com/stanislaw)) +- Pass `count` as keyword argument to `re.sub()` [\#194](https://github.com/mull-project/FileCheck.py/pull/194) ([rathann](https://github.com/rathann)) + +## [v0.0.23](https://github.com/mull-project/FileCheck.py/tree/v0.0.23) (2023-01-10) + +[Full Changelog](https://github.com/mull-project/FileCheck.py/compare/v0.0.22...v0.0.23) + +**Merged pull requests:** + +- Bump version to 0.0.23 [\#193](https://github.com/mull-project/FileCheck.py/pull/193) ([stanislaw](https://github.com/stanislaw)) +- CI: Drop Python 3.6 jobs [\#192](https://github.com/mull-project/FileCheck.py/pull/192) ([stanislaw](https://github.com/stanislaw)) +- Use poetry-core as the build backend instead of full poetry [\#191](https://github.com/mull-project/FileCheck.py/pull/191) ([hroncok](https://github.com/hroncok)) +- Initially strip only newlines from matched lines [\#189](https://github.com/mull-project/FileCheck.py/pull/189) ([stanislaw](https://github.com/stanislaw)) +- README: docs: point to stable channel [\#187](https://github.com/mull-project/FileCheck.py/pull/187) ([stanislaw](https://github.com/stanislaw)) +- Regenerate CHANGELOG again [\#186](https://github.com/mull-project/FileCheck.py/pull/186) ([stanislaw](https://github.com/stanislaw)) - Regenerate CHANGELOG [\#185](https://github.com/mull-project/FileCheck.py/pull/185) ([stanislaw](https://github.com/stanislaw)) - Bump version: 0.0.20 → 0.0.21 [\#184](https://github.com/mull-project/FileCheck.py/pull/184) ([stanislaw](https://github.com/stanislaw)) +## [v0.0.22](https://github.com/mull-project/FileCheck.py/tree/v0.0.22) (2022-02-16) + +[Full Changelog](https://github.com/mull-project/FileCheck.py/compare/v0.0.21...v0.0.22) + ## [v0.0.21](https://github.com/mull-project/FileCheck.py/tree/v0.0.21) (2021-12-05) [Full Changelog](https://github.com/mull-project/FileCheck.py/compare/v0.0.20...v0.0.21) @@ -147,7 +171,6 @@ - Switch from Makefile to Invoke \(closes \#102\) [\#107](https://github.com/mull-project/FileCheck.py/pull/107) ([stanislaw](https://github.com/stanislaw)) - Update CHANGELOG [\#106](https://github.com/mull-project/FileCheck.py/pull/106) ([stanislaw](https://github.com/stanislaw)) - Bump version: 0.0.12 → 0.0.13 [\#105](https://github.com/mull-project/FileCheck.py/pull/105) ([stanislaw](https://github.com/stanislaw)) -- Bump version: 0.0.11 → 0.0.12 [\#98](https://github.com/mull-project/FileCheck.py/pull/98) ([stanislaw](https://github.com/stanislaw)) ## [v0.0.13](https://github.com/mull-project/FileCheck.py/tree/v0.0.13) (2020-03-25) @@ -166,6 +189,7 @@ - CHECK-NOT: Fix edge case when CHECK\_NOT strings get shadowed by each [\#104](https://github.com/mull-project/FileCheck.py/pull/104) ([stanislaw](https://github.com/stanislaw)) - tests/integration: add FileCheck 9.0.1 Linux and macOS [\#101](https://github.com/mull-project/FileCheck.py/pull/101) ([stanislaw](https://github.com/stanislaw)) - Update CHANGELOG [\#99](https://github.com/mull-project/FileCheck.py/pull/99) ([stanislaw](https://github.com/stanislaw)) +- Bump version: 0.0.11 → 0.0.12 [\#98](https://github.com/mull-project/FileCheck.py/pull/98) ([stanislaw](https://github.com/stanislaw)) ## [v0.0.12](https://github.com/mull-project/FileCheck.py/tree/v0.0.12) (2020-02-16) @@ -173,7 +197,7 @@ **Closed issues:** -- `assert current\_scan\_base \> 0` [\#96](https://github.com/mull-project/FileCheck.py/issues/96) +- `assert current_scan_base > 0` [\#96](https://github.com/mull-project/FileCheck.py/issues/96) - Missing LICENSE file? [\#95](https://github.com/mull-project/FileCheck.py/issues/95) - Add documentation [\#31](https://github.com/mull-project/FileCheck.py/issues/31) @@ -287,23 +311,6 @@ - Fix scanning for the best intended match [\#50](https://github.com/mull-project/FileCheck.py/pull/50) ([stanislaw](https://github.com/stanislaw)) - Bump version: 0.0.2 → 0.0.3 [\#49](https://github.com/mull-project/FileCheck.py/pull/49) ([stanislaw](https://github.com/stanislaw)) - --version option [\#48](https://github.com/mull-project/FileCheck.py/pull/48) ([stanislaw](https://github.com/stanislaw)) - -## [v0.0.3](https://github.com/mull-project/FileCheck.py/tree/v0.0.3) (2019-12-05) - -[Full Changelog](https://github.com/mull-project/FileCheck.py/compare/ce965cb5571be21d0c38f6f64c6a85cc9720b620...v0.0.3) - -**Implemented enhancements:** - -- Feature: --check-prefix option [\#21](https://github.com/mull-project/FileCheck.py/issues/21) -- Feature: --strict-whitespace option [\#4](https://github.com/mull-project/FileCheck.py/issues/4) - -**Closed issues:** - -- Provide help command [\#41](https://github.com/mull-project/FileCheck.py/issues/41) -- Feature: "note: possible intended match here". [\#10](https://github.com/mull-project/FileCheck.py/issues/10) - -**Merged pull requests:** - - --help command: remove artifacts introduced by testing [\#47](https://github.com/mull-project/FileCheck.py/pull/47) ([stanislaw](https://github.com/stanislaw)) - Everything what's needed to publish a pip package [\#45](https://github.com/mull-project/FileCheck.py/pull/45) ([stanislaw](https://github.com/stanislaw)) - Help command: enough to get going [\#44](https://github.com/mull-project/FileCheck.py/pull/44) ([stanislaw](https://github.com/stanislaw)) @@ -340,6 +347,20 @@ - Fix test: CHECK/one\_string/01-negative\_match [\#2](https://github.com/mull-project/FileCheck.py/pull/2) ([stanislaw](https://github.com/stanislaw)) - Feature: CHECK-NOT/one\_string/01-negative\_match [\#1](https://github.com/mull-project/FileCheck.py/pull/1) ([stanislaw](https://github.com/stanislaw)) +## [v0.0.3](https://github.com/mull-project/FileCheck.py/tree/v0.0.3) (2019-12-05) + +[Full Changelog](https://github.com/mull-project/FileCheck.py/compare/41176a9c5044d5c76dc0c0655f15f8ecebcb8bb3...v0.0.3) + +**Implemented enhancements:** + +- Feature: --check-prefix option [\#21](https://github.com/mull-project/FileCheck.py/issues/21) +- Feature: --strict-whitespace option [\#4](https://github.com/mull-project/FileCheck.py/issues/4) + +**Closed issues:** + +- Provide help command [\#41](https://github.com/mull-project/FileCheck.py/issues/41) +- Feature: "note: possible intended match here". [\#10](https://github.com/mull-project/FileCheck.py/issues/10) + \* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)* From 10f7429392f5010ee340b15b5b6c16c85b2a7884 Mon Sep 17 00:00:00 2001 From: Stanislav Pankevich Date: Sun, 26 Nov 2023 20:45:37 +0100 Subject: [PATCH 2/6] Upgrade to new Read the Docs config --- .readthedocs.yaml | 10 +++++++--- docs/conf.py | 20 +++++++++++++++++--- requirements.dev.txt | 3 +++ 3 files changed, 27 insertions(+), 6 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1a4427a..430e62a 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -12,10 +12,14 @@ sphinx: # Optionally build your docs in additional formats such as PDF and ePub formats: - pdf +# - epub + +build: + os: ubuntu-22.04 + tools: + python: "3.8" # Optionally set the version of Python and requirements required to build your docs python: - version: 3.5 install: - - requirements: docs/requirements.txt - + - requirements: requirements.dev.txt diff --git a/docs/conf.py b/docs/conf.py index 741bcdf..f164bd5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -3,6 +3,8 @@ # This file only contains a selection of the most common options. For a full # list see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html +import os +import sys # -- Path setup -------------------------------------------------------------- @@ -16,6 +18,20 @@ import guzzle_sphinx_theme +try: + filecheck_root_path = os.path.abspath( + os.path.join(os.path.dirname(__file__), "..") + ) + if not os.path.isdir(filecheck_root_path): + raise FileNotFoundError + sys.path.append(filecheck_root_path) + from filecheck.filecheck import __version__ as filecheck_version +except Exception as exception: + print( # noqa: T201 + f"Could not resolve a path to filecheck's root: {exception}" + ) + sys.exit(1) + # -- Project information ----------------------------------------------------- project = "FileCheck.py" @@ -23,7 +39,7 @@ author = "Stanislav Pankevich" # The full version, including alpha/beta/rc tags -release = "0.0.1" +release = filecheck_version # -- General configuration --------------------------------------------------- @@ -51,8 +67,6 @@ extensions.append("guzzle_sphinx_theme") html_theme = "guzzle_sphinx_theme" -# html_theme = 'pyramid' - html_theme_options = { "project_nav_name": "Mull", } diff --git a/requirements.dev.txt b/requirements.dev.txt index 96da735..55ccd07 100644 --- a/requirements.dev.txt +++ b/requirements.dev.txt @@ -11,3 +11,6 @@ flake8>=3.9.2 coverage>=5.4 pytest>=6.2.2 lit>=0.9 + +# Docs +guzzle_sphinx_theme From 81b1b42dd42c848e50d0e5fe8ec4b6648ece44be Mon Sep 17 00:00:00 2001 From: Stanislav Pankevich Date: Wed, 10 Jul 2024 10:26:03 +0200 Subject: [PATCH 3/6] Update README.md --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1e91c7f..2ade03b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# FileCheck.py +# FileCheck.py (Discontinued) Attempt to reimplement LLVM's FileCheck using Python. @@ -6,6 +6,12 @@ Attempt to reimplement LLVM's FileCheck using Python. ![](https://github.com/mull-project/FileCheck.py/workflows/FileCheck.py%20on%20Linux/badge.svg) ![](https://github.com/mull-project/FileCheck.py/workflows/FileCheck.py%20on%20Windows/badge.svg) +## 2024-07-10 STATUS UPDATE - PROJECT DISCONTINUED + +The project has been discontinued in favor of another project: [antonlydike/filecheck](https://github.com/AntonLydike/filecheck), where the developers are aiming to achieve greater compatibility with the upstream LLVM FileCheck and add more features that this project was lacking. + +The filecheck PyPI package has also been transferred to the owner of antonlydike/filecheck. + ## Background Many software projects could benefit from a suite of LLVM LIT integration tests. From 7ac47111fac50a6ecae3953c6825953304b0c94f Mon Sep 17 00:00:00 2001 From: Stanislav Pankevich Date: Wed, 10 Jul 2024 10:30:18 +0200 Subject: [PATCH 4/6] Update 01-what-is-filecheck.rst --- docs/01-what-is-filecheck.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/01-what-is-filecheck.rst b/docs/01-what-is-filecheck.rst index 0db90d4..05a518c 100644 --- a/docs/01-what-is-filecheck.rst +++ b/docs/01-what-is-filecheck.rst @@ -12,6 +12,13 @@ FileCheck is most often used in a combination with another tool called **LIT from the test files, FileCheck is used as a test matcher tool that checks output of the commands run by LIT. +2024-07-10 STATUS UPDATE - PROJECT DISCONTINUED +----------------------------------------------- + +The project has been discontinued in favor of another project: `antonlydike/filecheck `_, where the developers are aiming to achieve greater compatibility with the upstream LLVM FileCheck and add more features that this project was lacking. + +The filecheck PyPI package has also been transferred to the owner of antonlydike/filecheck. + Why Python port? ---------------- From 61d503a9538e157060d4d37341138411bee5df48 Mon Sep 17 00:00:00 2001 From: Stanislav Pankevich Date: Wed, 10 Jul 2024 10:34:07 +0200 Subject: [PATCH 5/6] Update 02-installation.rst --- docs/02-installation.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/02-installation.rst b/docs/02-installation.rst index 8a41a6e..adfefd3 100644 --- a/docs/02-installation.rst +++ b/docs/02-installation.rst @@ -12,3 +12,10 @@ LIT is also a pip package: .. code-block:: bash pip install lit + +2024-07-10 STATUS UPDATE - PROJECT DISCONTINUED +----------------------------------------------- + +The project has been discontinued in favor of another project: `antonlydike/filecheck `_, where the developers are aiming to achieve greater compatibility with the upstream LLVM FileCheck and add more features that this project was lacking. + +The filecheck PyPI package has also been transferred to the owner of antonlydike/filecheck. From 0b6b32544560035b0628c704102e574a0548d889 Mon Sep 17 00:00:00 2001 From: Stanislav Pankevich Date: Wed, 10 Jul 2024 10:36:46 +0200 Subject: [PATCH 6/6] Update 08-roadmap.rst --- docs/08-roadmap.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/08-roadmap.rst b/docs/08-roadmap.rst index 0841f73..28ee7c4 100644 --- a/docs/08-roadmap.rst +++ b/docs/08-roadmap.rst @@ -3,6 +3,15 @@ Roadmap ======= +2024-07-10 STATUS UPDATE - PROJECT DISCONTINUED +----------------------------------------------- + +The project has been discontinued in favor of another project: `antonlydike/filecheck `_, where the developers are aiming to achieve greater compatibility with the upstream LLVM FileCheck and add more features that this project was lacking. + +The filecheck PyPI package has also been transferred to the owner of antonlydike/filecheck. + +---- + As described in :doc:`01-what-is-filecheck`, FileCheck.py is only a Python port for LLVM's FileCheck. It is not intended to be a replacement for LLVM's FileCheck.