Skip to content

Commit

Permalink
release_v0.3
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderDokuchaev committed Mar 4, 2024
1 parent 9de2815 commit 7501c0e
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 20 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/github_action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
12 changes: 0 additions & 12 deletions .github/workflows/ubuntu.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
17 changes: 17 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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)`
- `<a href="link"></a>`
- `[text](link "title")`
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
```
Expand Down
11 changes: 7 additions & 4 deletions action.yaml
Original file line number Diff line number Diff line change
@@ -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'
Expand All @@ -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:
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand Down

0 comments on commit 7501c0e

Please sign in to comment.