Repository navigation
docs: Add Korean Web Manual and GitHub Pages Deployment #13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
c69efca
docs: Add Korean Web Manual and GitHub Pages deployment workflow
seonghobae cd441ea
docs: Enhance web manual with concrete API schemas, architecture, and…
seonghobae c24751c
docs: Massive rewrite of web manual to be ultra-specific with exact s…
seonghobae 2c92e6a
test: add enforced quality gate (#2)
seonghobae d726acd
ci: keep Node24 forcing without tripping scorecard checks (#16)
seonghobae 6721ac4
ci: keep Node24 forcing without tripping scorecard checks (#17)
seonghobae 860e851
ci: scope workflow write permissions to the jobs that need them (#18)
seonghobae File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| version: 2.1 | ||
|
|
||
| jobs: | ||
| quality-gate: | ||
| docker: | ||
| - image: cimg/python:3.10 | ||
| steps: | ||
| - checkout | ||
| - run: | ||
| name: Install uv | ||
| command: | | ||
| export UV_UNMANAGED_INSTALL=1 | ||
| export UV_NO_MODIFY_PATH=1 | ||
| curl -LsSf -o /tmp/uv-install.sh https://astral.sh/uv/0.11.3/install.sh | ||
| sh /tmp/uv-install.sh | ||
| echo 'export PATH="$HOME/.local/bin:$PATH"' >> "$BASH_ENV" | ||
| - run: | ||
| name: Install project dependencies | ||
| command: | | ||
| source "$BASH_ENV" | ||
| uv sync --locked --extra dev | ||
| - run: | ||
| name: Run warnings-as-errors tests | ||
| command: | | ||
| source "$BASH_ENV" | ||
| PYTHONWARNINGS=error uv run pytest | ||
| - run: | ||
| name: Run coverage quality gate | ||
| command: | | ||
| source "$BASH_ENV" | ||
| uv run pytest --cov=src/newsdom_api --cov-branch --cov-report=term-missing --cov-fail-under=100 | ||
|
|
||
| workflows: | ||
| quality-gate: | ||
| jobs: | ||
| - quality-gate |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| language: ko | ||
|
|
||
| reviews: | ||
| profile: chill | ||
| request_changes_workflow: true | ||
| auto_review: | ||
| enabled: true | ||
| auto_incremental_review: true |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| version: 2 | ||
| updates: | ||
| - package-ecosystem: github-actions | ||
| directory: "/" | ||
| target-branch: develop | ||
| schedule: | ||
| interval: weekly | ||
| groups: | ||
| github-actions: | ||
| patterns: | ||
| - "*" | ||
|
|
||
| - package-ecosystem: "pip" | ||
| directory: "/" | ||
| target-branch: develop | ||
| schedule: | ||
| interval: weekly | ||
| groups: | ||
| python: | ||
| patterns: | ||
| - "*" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| name: Deploy Web Manual to GitHub Pages | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| - master | ||
| - develop | ||
| paths: | ||
| - 'manual/**' | ||
| - 'mkdocs.yml' | ||
| - '.github/workflows/gh-pages.yml' | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| concurrency: | ||
| group: github-pages | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: read | ||
| env: | ||
| FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 | ||
| with: | ||
| fetch-depth: 0 | ||
| persist-credentials: false | ||
|
|
||
| - name: Set up Python | ||
| uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 | ||
| with: | ||
| python-version: '3.10' | ||
|
|
||
| - name: Set up uv | ||
| uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e | ||
| with: | ||
| version: '0.9.29' | ||
| enable-cache: true | ||
|
|
||
| - name: Install locked docs dependencies | ||
| run: uv sync --frozen --extra docs | ||
|
|
||
| - name: Build documentation site | ||
| run: uv run mkdocs build --strict | ||
|
|
||
| - name: Upload GitHub Pages artifact | ||
| uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa | ||
| with: | ||
| path: site | ||
|
|
||
| deploy: | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| pages: write | ||
| id-token: write | ||
| env: | ||
| FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| name: quality-gate | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main, develop] | ||
| pull_request: | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| quality-gate: | ||
| name: quality-gate | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 | ||
|
|
||
| - name: Setup Python | ||
| uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 | ||
| with: | ||
| python-version: '3.10' | ||
|
|
||
| - name: Setup uv | ||
| uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e | ||
| with: | ||
| version: '0.11.3' | ||
|
|
||
| - name: Install package | ||
| run: uv sync --locked --extra dev | ||
|
|
||
| - name: Run quality gate | ||
| env: | ||
| PYTHONWARNINGS: error | ||
| run: uv run pytest --cov=src/newsdom_api --cov-branch --cov-report=term-missing --cov-fail-under=100 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| name: release | ||
|
|
||
| on: | ||
| push: | ||
| tags: | ||
| - 'v*' | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: write | ||
| attestations: write | ||
| id-token: write | ||
|
|
||
| jobs: | ||
| release: | ||
| name: release | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 | ||
|
|
||
| - name: Setup Python | ||
| uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 | ||
| with: | ||
| python-version: '3.10' | ||
|
|
||
| - name: Setup uv | ||
| uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e | ||
| with: | ||
| version: '0.11.3' | ||
|
|
||
| - name: Build artifacts | ||
| run: uv build | ||
|
|
||
| - name: Generate checksums and manifest | ||
| run: | | ||
| sha256sum dist/* > dist/SHA256SUMS.txt | ||
| python scripts/release/build_release_manifest.py dist dist/release-manifest.json | ||
|
|
||
| - name: Upload release artifacts | ||
| uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 | ||
| with: | ||
| name: release-artifacts | ||
| path: dist/* | ||
|
|
||
| - name: Attest build provenance | ||
| uses: actions/attest-build-provenance@e8998f949152b193b063cb0ec769d69d929409be | ||
| with: | ||
| subject-path: 'dist/*' | ||
|
|
||
| - name: Publish GitHub release | ||
| if: startsWith(github.ref, 'refs/tags/') | ||
| env: | ||
| GH_TOKEN: ${{ github.token }} | ||
| run: | | ||
| if gh release view "${GITHUB_REF_NAME}" >/dev/null 2>&1; then | ||
| gh release upload "${GITHUB_REF_NAME}" dist/* --clobber | ||
| else | ||
| gh release create "${GITHUB_REF_NAME}" dist/* --generate-notes | ||
| fi | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,6 +2,7 @@ | |
| __pycache__/ | ||
| *.egg-info/ | ||
| .pytest_cache/ | ||
| .coverage | ||
| .venv/ | ||
| dist/ | ||
| build/ | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # Changelog | ||
|
|
||
| All notable changes to this project will be documented in this file. | ||
|
|
||
| The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), | ||
| and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ### Added | ||
|
|
||
| - MinerU-backed DOM parsing API for scanned Japanese newspaper PDFs | ||
| - Synthetic newspaper fixture generation and structural equivalence checks | ||
| - Protected-branch CI, security gates, release provenance workflow, and Git Flow documentation |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.