diff --git a/.github/markdown-link-check.json b/.github/markdown-link-check.json deleted file mode 100644 index 4ec268d3..00000000 --- a/.github/markdown-link-check.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "ignorePatterns": [ - { - "pattern": "img.shields.io" - }, - { - "pattern": "^https://twitter.com/artichokeruby" - } - ], - "replacementPatterns": [], - "httpHeaders": [ - { - "urls": ["https://crates.io"], - "headers": { - "Accept": "text/html" - } - } - ], - "retryOn429": true, - "retryCount": 3, - "fallbackRetryDelay": "60s" -} 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 f2ae64bd..3de88950 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -108,24 +108,26 @@ 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 Roe 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 Roe unit tests +rake unicode:build # Rebuild Rust generated Rust sources from Unicode data +rake unicode:update # Update Unicode data ``` To lint Ruby sources, roe uses [RuboCop]. RuboCop runs as part of the `lint` diff --git a/Rakefile b/Rakefile index 6c024f79..0d46235f 100644 --- a/Rakefile +++ b/Rakefile @@ -161,22 +161,3 @@ namespace :unicode 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