Skip to content

Commit 3493e42

Browse files
authored
docs: tidy up website tooling and repo config (#2327)
Website tooling and repo config cleanup, same as apify-sdk-python#1181 and apify-client-python#1126. - Website code is linted with type-aware oxlint (new `website/tsconfig.json`), and warnings fail CI. Fixed the few issues it found. - Patches moved from patch-package to pnpm `patchedDependencies`, deduplicating the `@docusaurus/core` patch. - Removed unused website deps and aligned version ranges with the lockfile. - YAML: 2-space indent, no quotes unless needed, double quotes when they are. - markdownlint: default 2-space list indent (as in apify-docs) and fenced code blocks only. - Fixed the `.editorconfig` YAML glob. *✍️ Drafted by Claude Code*
1 parent 3f186aa commit 3493e42

26 files changed

Lines changed: 240 additions & 885 deletions

‎.editorconfig‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,6 @@ quote_type = single
1212
[Makefile]
1313
indent_style = tab
1414

15-
[{*.yaml, *.yml}]
15+
[{*.yaml,*.yml}]
1616
indent_size = 2
17+
quote_type = double

‎.github/workflows/manual_release_beta.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
uses: apify/actions/wait-for-checks@v1.6.2
2828
with:
2929
ref: ${{ github.sha }}
30-
check-regexp: '^Checks'
30+
check-regexp: ^Checks
3131

3232
release_prepare:
3333
name: Release prepare

‎.github/workflows/manual_release_docs.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ jobs:
4646
uses: apify/actions/wait-for-checks@v1.6.2
4747
with:
4848
ref: ${{ github.sha }}
49-
check-regexp: '^Checks'
49+
check-regexp: ^Checks
5050

5151
- name: Checkout repository
5252
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

‎.github/workflows/manual_release_stable.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ jobs:
4040
uses: apify/actions/wait-for-checks@v1.6.2
4141
with:
4242
ref: ${{ github.sha }}
43-
check-regexp: '^Checks'
43+
check-regexp: ^Checks
4444

4545
release_prepare:
4646
name: Release prepare

‎.github/workflows/manual_version_docs.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ jobs:
4646
uses: apify/actions/wait-for-checks@v1.6.2
4747
with:
4848
ref: ${{ github.sha }}
49-
check-regexp: '^Checks'
49+
check-regexp: ^Checks
5050

5151
- name: Checkout repository
5252
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
@@ -126,6 +126,6 @@ jobs:
126126
uses: apify/actions/signed-commit@v1.6.2
127127
with:
128128
message: "docs: Version docs for v${{ steps.snapshot.outputs.version }} [skip ci]"
129-
add: 'website/versioned_docs website/versioned_sidebars website/versions.json'
130-
pull: '--rebase --autostash'
129+
add: website/versioned_docs website/versioned_sidebars website/versions.json
130+
pull: --rebase --autostash
131131
github-token: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }}

‎.github/workflows/on_schedule_tests.yaml‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,22 @@ on:
55
workflow_dispatch:
66
inputs:
77
slack_test:
8-
description: 'Skip the tests and only send a Slack notification, to check the alerting path.'
8+
description: Skip the tests and only send a Slack notification, to check the alerting path.
99
type: boolean
1010
default: false
1111

1212
# Runs on weekdays at 01:00 UTC.
1313
schedule:
14-
- cron: '0 1 * * 1-5'
14+
- cron: 0 1 * * 1-5
1515

1616
# Runs on pull requests that touch the template files, the template e2e tests,
1717
# or this workflow itself, so that changes affecting the scheduled tests are
1818
# validated before they are merged.
1919
pull_request:
2020
paths:
21-
- 'src/crawlee/project_template/**'
22-
- 'tests/e2e/**'
23-
- '.github/workflows/on_schedule_tests.yaml'
21+
- src/crawlee/project_template/**
22+
- tests/e2e/**
23+
- .github/workflows/on_schedule_tests.yaml
2424

2525
concurrency:
2626
group: scheduled-tests
@@ -42,11 +42,11 @@ jobs:
4242
fail-fast: false
4343
max-parallel: 12
4444
matrix:
45-
crawler-type: ["playwright_camoufox", "playwright_chrome", "playwright_firefox", "playwright_webkit", "playwright", "parsel", "beautifulsoup", "adaptive_beautifulsoup", "adaptive_parsel", "stagehand"]
46-
http-client: ["httpx", "curl_impersonate", "impit"]
47-
package-manager: ["pip", "uv", "poetry"]
45+
crawler-type: [playwright_camoufox, playwright_chrome, playwright_firefox, playwright_webkit, playwright, parsel, beautifulsoup, adaptive_beautifulsoup, adaptive_parsel, stagehand]
46+
http-client: [httpx, curl_impersonate, impit]
47+
package-manager: [pip, uv, poetry]
4848

49-
runs-on: "ubuntu-latest"
49+
runs-on: ubuntu-latest
5050

5151
steps:
5252
- name: Checkout repository

‎.github/workflows/update_playwright_version.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ on:
66

77
# Runs every workday (Monday to Friday) at 04:00 UTC.
88
schedule:
9-
- cron: '0 4 * * 1-5'
9+
- cron: 0 4 * * 1-5
1010

1111
concurrency:
1212
group: update-playwright-version
@@ -43,7 +43,7 @@ jobs:
4343
- name: Set up Python
4444
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
4545
with:
46-
python-version: '3.14'
46+
python-version: "3.14"
4747

4848
- name: Update Playwright version
4949
run: python scripts/update_playwright_version.py
@@ -62,10 +62,10 @@ jobs:
6262
if: steps.changes.outputs.has-changes == 'true'
6363
uses: apify/actions/signed-commit@v1.6.2
6464
with:
65-
message: 'chore: update Playwright version in project template'
65+
message: "chore: update Playwright version in project template"
6666
github-token: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }}
6767
branch: ${{ env.BRANCH_NAME }}
68-
create-branch: 'true'
68+
create-branch: "true"
6969

7070
- name: Create or update Pull Request
7171
if: steps.commit-and-push.outputs.committed == 'true'

‎.github/workflows/update_public_suffix_list.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ on:
66

77
# Runs every workday (Monday to Friday) at 04:00 UTC.
88
schedule:
9-
- cron: '0 4 * * 1-5'
9+
- cron: 0 4 * * 1-5
1010

1111
concurrency:
1212
group: update-public-suffix-list
@@ -43,7 +43,7 @@ jobs:
4343
- name: Set up Python
4444
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
4545
with:
46-
python-version: '3.14'
46+
python-version: "3.14"
4747

4848
- name: Update Public Suffix List
4949
run: python scripts/update_public_suffix_list.py
@@ -62,10 +62,10 @@ jobs:
6262
if: steps.changes.outputs.has-changes == 'true'
6363
uses: apify/actions/signed-commit@v1.6.2
6464
with:
65-
message: 'chore: update Public Suffix List snapshot'
65+
message: "chore: update Public Suffix List snapshot"
6666
github-token: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }}
6767
branch: ${{ env.BRANCH_NAME }}
68-
create-branch: 'true'
68+
create-branch: "true"
6969

7070
- name: Create or update Pull Request
7171
if: steps.commit-and-push.outputs.committed == 'true'

‎.markdownlint.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ line-length: false
88
ul-style:
99
style: dash
1010

11-
# Nested unordered lists use 4-space indentation.
12-
ul-indent:
13-
indent: 4
11+
# Code blocks are fenced, never indented.
12+
code-block-style:
13+
style: fenced
1414

1515
# Docs are MDX and embed JSX components.
1616
no-inline-html: false

‎.rules.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,12 @@ Note: `uv run poe unit-tests` first runs tests marked `@pytest.mark.run_alone` i
5252
- **Type checker**: ty (Astral's type checker), target Python 3.10
5353
- **Async mode**: pytest-asyncio in `auto` mode (no need for `@pytest.mark.asyncio`)
5454
- **Commits**: [Conventional Commits](https://www.conventionalcommits.org/) format. Choose the type based on *what* changed, not just *why*:
55-
- `feat:` / `fix:` / `perf:` / `refactor:` / `style:` — **source code only**; these trigger a release and appear in the changelog
56-
- `test:` — test additions or changes (no release triggered)
57-
- `docs:` — documentation changes; also triggers a doc release on master
58-
- `ci:` — CI/workflow changes
59-
- `chore:` — dependency bumps, tooling, and other housekeeping
60-
- `build:` — build system changes
55+
- `feat:` / `fix:` / `perf:` / `refactor:` / `style:` — **source code only**; these trigger a release and appear in the changelog
56+
- `test:` — test additions or changes (no release triggered)
57+
- `docs:` — documentation changes; also triggers a doc release on master
58+
- `ci:` — CI/workflow changes
59+
- `chore:` — dependency bumps, tooling, and other housekeeping
60+
- `build:` — build system changes
6161

6262
## Architecture
6363

0 commit comments

Comments
 (0)