diff --git a/.github/workflows/github_action.yml b/.github/workflows/github_action.yml index f2079fe..038fe4e 100644 --- a/.github/workflows/github_action.yml +++ b/.github/workflows/github_action.yml @@ -15,6 +15,6 @@ jobs: runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v4 - - uses: AlexanderDokuchaev/md-dead-link-check@main + - uses: AlexanderDokuchaev/md-dead-link-check@0.3 with: config: pyproject.toml diff --git a/.github/workflows/ubuntu.yml b/.github/workflows/ubuntu.yml index 9fbceaa..db468de 100644 --- a/.github/workflows/ubuntu.yml +++ b/.github/workflows/ubuntu.yml @@ -11,18 +11,6 @@ on: - synchronize jobs: - pre-commit: - runs-on: ubuntu-22.04 - steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v4 - with: - python-version: "3.10" - - name: Install pre-commit - run: pip install pre-commit==3.2.2 - - name: Run pre-commit - run: pre-commit run -a - pytest: runs-on: ubuntu-22.04 strategy: diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..a93113b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,17 @@ +# Changelog + +## 0.3 + +- Multi-platform support: Added support for Windows and macOS. +- Enhanced pre-commit hook: Set `always_run: True` for the pre-commit hook to ensure consistent detection of links to removed files before commit. +- Improved output: Added coloring to the output for better readability. Disable coloring with the --no-color argument. +- Verbose mode: Added the `--verbose` argument to display the status of all detected links, not just the first instance. +- Automatic proxy detection: Uses `trust_env=True` for `aiohttp.ClientSession` to automatically detect proxy settings. +- Extended configuration options: + - Supports `fnmatch` syntax for pattern matching in configuration files. + - Added new configuration options `force_get_requests_for_links`, `validate_ssl`, `catch_response_codes`. +- Detect relative links to files that is not within repository. +- Enhanced link detection: Improved detection of links in various formats, including: + - `[![img](img_link)](link)` + - `` + - `[text](link "title")` diff --git a/README.md b/README.md index 0dfb29d..21768c8 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ jobs: runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v4 - - uses: AlexanderDokuchaev/md-dead-link-check@latest + - uses: AlexanderDokuchaev/md-dead-link-check@0.3 ``` ### Option 2: Pre-Commit @@ -51,7 +51,7 @@ Adding to your `.pre-commit-config.yaml` to integrate in [pre-commit](https://pr ```yaml - repo: https://github.com/AlexanderDokuchaev/md-dead-link-check - rev: latest + rev: 0.3 hooks: - id: md-dead-link-check ``` diff --git a/action.yaml b/action.yaml index 3a0b238..81e279b 100644 --- a/action.yaml +++ b/action.yaml @@ -1,5 +1,5 @@ -name: 'Markdown dead link checker GitHub Action' -description: 'A GitHub Action to help you keep your Markdown files free of broken links!' +name: 'Markdown dead link checker' +description: 'This handy tool helps you maintain the integrity of your Markdown files by identifying broken links.' branding: icon: 'external-link' color: 'blue' @@ -9,7 +9,10 @@ inputs: description: 'Config toml file' required: false default: 'pyproject.toml' - + version: + description: 'Version of package' + required: false + default: '0.3' runs: using: 'composite' steps: @@ -19,7 +22,7 @@ runs: python-version: '3.10' - name: Install md-dead-link-check - run: pip install md-dead-link-check==0.2 + run: pip install md-dead-link-check==${{ inputs.version }} shell: bash - name: Fetch the number's square diff --git a/pyproject.toml b/pyproject.toml index 0c21d17..338e588 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -2,7 +2,7 @@ name = "md_dead_link_check" description = "This is a lightweight and fast tool to help you keep your Markdown files free of broken links." readme = "README.md" -version = "0.2" +version = "0.3" license = {file = "LICENSE"} requires-python = ">= 3.8" dependencies = [