From 43b548b8f53140ce1c7cba36e943c77d9150d6bd Mon Sep 17 00:00:00 2001 From: Ryan Lopopolo Date: Wed, 25 Dec 2024 10:47:51 +0900 Subject: [PATCH] Remove markdown link check This CI job is incredibly flaky and provides little value. Remove it to reduce maintenance burden. --- .github/markdown-link-check.json | 22 ------------- .github/workflows/markdown-link-check.yaml | 34 -------------------- CONTRIBUTING.md | 36 +++++++++++----------- Rakefile | 19 ------------ 4 files changed, 18 insertions(+), 93 deletions(-) delete mode 100644 .github/markdown-link-check.json delete mode 100644 .github/workflows/markdown-link-check.yaml diff --git a/.github/markdown-link-check.json b/.github/markdown-link-check.json deleted file mode 100644 index ef93a63c..00000000 --- a/.github/markdown-link-check.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "ignorePatterns": [ - { - "pattern": "img.shields.io" - }, - { - "pattern": "^https://docs.rs/ruby-file-expand-path$" - }, - { - "pattern": "^https://twitter.com/artichokeruby" - } - ], - "replacementPatterns": [], - "httpHeaders": [ - { - "urls": ["https://crates.io"], - "headers": { - "Accept": "text/html" - } - } - ] -} diff --git a/.github/workflows/markdown-link-check.yaml b/.github/workflows/markdown-link-check.yaml deleted file mode 100644 index e515e228..00000000 --- a/.github/workflows/markdown-link-check.yaml +++ /dev/null @@ -1,34 +0,0 @@ ---- -"on": - push: - branches: - - trunk - paths: - - .github/markdown-link-check.json - - .github/workflows/markdown-link-check.yaml - - "**/*.md" - pull_request: - branches: - - trunk - paths: - - .github/markdown-link-check.json - - .github/workflows/markdown-link-check.yaml - - "**/*.md" - schedule: - - cron: "0 0 * * TUE" -name: Markdown Links Check -jobs: - check-links: - name: Check links - runs-on: ubuntu-latest - steps: - - name: Checkout repository - uses: actions/checkout@v4.2.2 - - - name: Check for broken links in markdown files - uses: gaurav-nelson/github-action-markdown-link-check@d53a906aa6b22b8979d33bc86170567e619495ec # v1.0.15 - with: - use-quiet-mode: "yes" - use-verbose-mode: "yes" - config-file: ".github/markdown-link-check.json" - folder-path: "." diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9ccb4188..137f8852 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -112,24 +112,24 @@ available tasks by running: ```console $ bundle exec rake --tasks -rake build # Build Rust workspace -rake bundle:audit:check # Checks the Gemfile.lock for insecure dependencies -rake bundle:audit:update # Updates the bundler-audit vulnerability database -rake doc # Generate Rust API documentation -rake doc:open # Generate Rust API documentation and open it in a web browser -rake fmt # Format sources -rake fmt:rust # Format Rust sources with rustfmt -rake fmt:text # Format text, YAML, and Markdown sources with prettier -rake format # Format sources -rake format:rust # Format Rust sources with rustfmt -rake format:text # Format text, YAML, and Markdown sources with prettier -rake lint # Lint sources -rake lint:clippy # Lint Rust sources with Clippy -rake lint:clippy:restriction # Lint Rust sources with Clippy restriction pass (unenforced lints) -rake lint:rubocop # Run RuboCop -rake lint:rubocop:autocorrect # Auto-correct RuboCop offenses -rake release:markdown_link_check # Check for broken links in markdown files -rake test # Run ruby-file-expand-path unit tests +rake build # Build Rust workspace +rake bundle:audit:check # Checks the Gemfile.lock for insecure dependencies +rake bundle:audit:update # Updates the bundler-audit vulnerability database +rake doc # Generate Rust API documentation +rake doc:open # Generate Rust API documentation and open it in a web browser +rake fmt # Format sources +rake fmt:rust # Format Rust sources with rustfmt +rake fmt:text # Format text, YAML, and Markdown sources with prettier +rake format # Format sources +rake format:rust # Format Rust sources with rustfmt +rake format:text # Format text, YAML, and Markdown sources with prettier +rake lint # Lint sources +rake lint:clippy # Lint Rust sources with Clippy +rake lint:clippy:restriction # Lint Rust sources with Clippy restriction pass (unenforced lints) +rake lint:rubocop # Run RuboCop +rake lint:rubocop:autocorrect # Autocorrect RuboCop offenses (only when it's safe) +rake lint:rubocop:autocorrect_all # Autocorrect RuboCop offenses (safe and unsafe) +rake test # Run ruby-file-expand-path unit tests ``` To lint Ruby sources, ruby-file-expand-path uses [RuboCop]. RuboCop runs as part diff --git a/Rakefile b/Rakefile index 5652a23e..ae697e79 100644 --- a/Rakefile +++ b/Rakefile @@ -90,22 +90,3 @@ task :test do end Bundler::Audit::Task.new - -namespace :release do - link_check_files = FileList.new('**/*.md') do |f| - f.exclude('node_modules/**/*') - f.exclude('**/target/**/*') - f.exclude('**/vendor/*/**/*') - f.include('*.md') - f.include('**/vendor/*.md') - end - - link_check_files.sort.uniq.each do |markdown| - desc 'Check for broken links in markdown files' - task markdown_link_check: markdown do - command = ['npx', 'markdown-link-check', '--config', '.github/markdown-link-check.json', markdown] - sh command.shelljoin - sleep(rand(1..5)) - end - end -end