Skip to content

chore(release): prepare initial 0.1.0 changelog metadata - #21

Closed
seonghobae wants to merge 9 commits into
mainfrom
release/v0.1.0
Closed

chore(release): prepare initial 0.1.0 changelog metadata#21
seonghobae wants to merge 9 commits into
mainfrom
release/v0.1.0

Conversation

@seonghobae

@seonghobae seonghobae commented Apr 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • add the initial 0.1.0 release entry to CHANGELOG.md while keeping the Unreleased section open
  • make the first changelog release entry linkable with explicit [Unreleased] and [0.1.0] references
  • lock the initial release metadata in with changelog regression tests before the first tag is cut

Verification

  • uv run pytest -q
  • PYTHONWARNINGS=error uv run pytest -q
  • uv run pytest --cov=src/newsdom_api --cov-branch --cov-report=term-missing --cov-fail-under=100 -q
  • uv run mkdocs build --strict

seonghobae and others added 9 commits April 9, 2026 08:47
…cripts, workflows, and internal architecture
* fix: scope scorecards push to develop

* test: add enforced quality gate

* test: cover synthetic helper branches

* chore: add automated dependency updates

* docs: add security reporting policy

* ci: pin workflow dependencies

* ci: pin workflow actions and broaden PR checks

* ci: lock uv installs and PR workflow coverage

* ci: add release provenance workflow

* ci: force github actions to node24

* docs: record OpenSSF badge decision

* docs: add changelog baseline

* ci: pin workflow dependencies (#5)

* ci: pin workflow dependencies

* ci: pin workflow actions and broaden PR checks

* ci: lock uv installs and PR workflow coverage

* ci: add release provenance workflow (#6)

* ci: add release provenance workflow

* ci: force github actions to node24 (#7)

* ci: force github actions to node24

* docs: record OpenSSF badge decision (#11)

* docs: record OpenSSF badge decision

* docs: add changelog baseline (#12)

* ci: align gh-pages workflow with repo policies

* test: tighten review-driven regressions

* docs: tighten manual examples

* test: strengthen review follow-up assertions

* docs: align installation guidance with recommendation

* ci: add CircleCI quality gate

* ci: harden CircleCI uv install

* test: tighten remaining reviewer regressions

* docs: clarify supported Python range without implying 3.10-only use

* ci: harden docs deploy path for reproducible Pages builds

* ci: close remaining automation review gaps

* docs: keep dev install examples shell-safe and in sync

* ci: enable repo-local CodeRabbit approval workflow
Bumps the github-actions group with 9 updates:

| Package | From | To |
| --- | --- | --- |
| [actions/checkout](https://github.com/actions/checkout) | `4.3.1` | `6.0.2` |
| [github/codeql-action](https://github.com/github/codeql-action) | `3.35.1` | `4.35.1` |
| [actions/setup-python](https://github.com/actions/setup-python) | `5.6.0` | `6.2.0` |
| [astral-sh/setup-uv](https://github.com/astral-sh/setup-uv) | `6.8.0` | `8.0.0` |
| [actions/upload-pages-artifact](https://github.com/actions/upload-pages-artifact) | `3.0.1` | `4.0.0` |
| [actions/deploy-pages](https://github.com/actions/deploy-pages) | `4.0.5` | `5.0.0` |
| [actions/upload-artifact](https://github.com/actions/upload-artifact) | `4.6.2` | `7.0.0` |
| [actions/attest-build-provenance](https://github.com/actions/attest-build-provenance) | `2.4.0` | `4.1.0` |
| [ossf/scorecard-action](https://github.com/ossf/scorecard-action) | `2.4.0` | `2.4.3` |


Updates `actions/checkout` from 4.3.1 to 6.0.2
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@34e1148...de0fac2)

Updates `github/codeql-action` from 3.35.1 to 4.35.1
- [Release notes](https://github.com/github/codeql-action/releases)
- [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md)
- [Commits](github/codeql-action@5c8a8a6...c10b806)

Updates `actions/setup-python` from 5.6.0 to 6.2.0
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](actions/setup-python@a26af69...a309ff8)

Updates `astral-sh/setup-uv` from 6.8.0 to 8.0.0
- [Release notes](https://github.com/astral-sh/setup-uv/releases)
- [Commits](astral-sh/setup-uv@d0cc045...cec2083)

Updates `actions/upload-pages-artifact` from 3.0.1 to 4.0.0
- [Release notes](https://github.com/actions/upload-pages-artifact/releases)
- [Commits](actions/upload-pages-artifact@56afc60...7b1f4a7)

Updates `actions/deploy-pages` from 4.0.5 to 5.0.0
- [Release notes](https://github.com/actions/deploy-pages/releases)
- [Commits](actions/deploy-pages@d6db901...cd2ce8f)

Updates `actions/upload-artifact` from 4.6.2 to 7.0.0
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](actions/upload-artifact@ea165f8...bbbca2d)

Updates `actions/attest-build-provenance` from 2.4.0 to 4.1.0
- [Release notes](https://github.com/actions/attest-build-provenance/releases)
- [Changelog](https://github.com/actions/attest-build-provenance/blob/main/RELEASE.md)
- [Commits](actions/attest-build-provenance@e8998f9...a2bbfa2)

Updates `ossf/scorecard-action` from 2.4.0 to 2.4.3
- [Release notes](https://github.com/ossf/scorecard-action/releases)
- [Changelog](https://github.com/ossf/scorecard-action/blob/main/RELEASE.md)
- [Commits](ossf/scorecard-action@62b2cac...4eaacf0)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: 6.0.2
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
- dependency-name: github/codeql-action
  dependency-version: 4.35.1
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
- dependency-name: actions/setup-python
  dependency-version: 6.2.0
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
- dependency-name: astral-sh/setup-uv
  dependency-version: 8.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
- dependency-name: actions/upload-pages-artifact
  dependency-version: 4.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
- dependency-name: actions/deploy-pages
  dependency-version: 5.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
- dependency-name: actions/upload-artifact
  dependency-version: 7.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
- dependency-name: actions/attest-build-provenance
  dependency-version: 4.1.0
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
- dependency-name: ossf/scorecard-action
  dependency-version: 2.4.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github-actions
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Apr 9, 2026

Copy link
Copy Markdown

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

워크스루

저장소의 품질 게이트 인프라를 도입하는 대규모 업데이트입니다. CircleCI 및 GitHub Actions 워크플로우, Dependabot/CodeRabbit 설정, 한국어 설명서(MkDocs), 보안 정책, 릴리스 자동화 스크립트, 전체 소스코드에 대한 docstring 추가, 100% 커버리지 강제화를 위한 광범위한 테스트가 포함되었습니다.

변경 사항

코호트 / 파일 요약
CI/CD 워크플로우
.github/workflows/quality-gate.yml, .github/workflows/codeql.yml, .github/workflows/dependency-review.yml, .github/workflows/gh-pages.yml, .github/workflows/release.yml, .github/workflows/tests.yml, .github/workflows/scorecards.yml
GitHub Actions 워크플로우 추가 및 업데이트: uv 기반 의존성 관리, 액션 SHAs 고정, FORCE_JAVASCRIPT_ACTIONS_TO_NODE24 환경 변수 설정, 100% 커버리지 강제화, Pages 배포 추가.
저장소 설정
.circleci/config.yml, .coderabbit.yaml, .github/dependabot.yml, .gitignore
CircleCI 품질 게이트 작업 흐름, CodeRabbit 검토 설정(Korean, chill profile), Dependabot pip/github-actions 업데이트 설정, 커버리지 출력 무시.
프로젝트 메타데이터
pyproject.toml
pytest-cov, pyyaml dev 의존성 추가, parser extra 제거, docs extra 추가(mkdocs), [tool.coverage] 구성(100% 강제, 브랜치 커버리지).
문서 - 설명서 및 정책
README.md, CONTRIBUTING.md, CHANGELOG.md, SECURITY.md
설치 및 개발 가이드 업데이트, 한국어 매뉴얼 링크 추가, "Keep a Changelog" 형식 CHANGELOG, 취약점 보고 정책 및 지원 브랜치 문서화.
한국어 매뉴얼 - MkDocs 설명서
mkdocs.yml, manual/index.md, manual/installation.md, manual/api-reference.md, manual/development.md
MkDocs 설정(Material 테마, 한국어), FastAPI 서버 실행 및 /parse 엔드포인트 사용법, 설치 단계, 개발 워크플로우(Git Flow, fixture 관리, 브랜치 정책).
아키텍처 및 계획 문서
docs/adr/0001-openssf-best-practices-badge.md, docs/adr/README.md, docs/plans/2026-04-08-quality-gate.md, docs/plans/2026-04-08-quality-gate-design.md
OpenSSF 배지 등록 연기 결정, 품질 게이트 계획(100% 커버리지, docstring 감사, CI 강제화).
릴리스 자동화 스크립트
scripts/release/build_release_manifest.py, scripts/__init__.py, scripts/release/__init__.py
SHA-256 다이제스트 및 아티팩트 메타데이터를 포함한 JSON 릴리스 매니페스트 생성.
소스코드 docstring
src/newsdom_api/dom_builder.py, src/newsdom_api/equivalence.py, src/newsdom_api/main.py, src/newsdom_api/mineru_runner.py, src/newsdom_api/schemas.py, src/newsdom_api/service.py, src/newsdom_api/synthetic.py
모듈, 함수, 클래스에 docstring 추가; /parse 엔드포인트 매개변수 타입 주석 개선(Annotated[UploadFile, File(...)]); service.py에 파일명 sanitization 추가.
광범위한 테스트 추가
tests/test_adr_docs.py, tests/test_changelog.py, tests/test_circleci_config.py, tests/test_coderabbit_config.py, tests/test_dependabot.py, tests/test_docstrings.py, tests/test_dom_builder.py, tests/test_equivalence.py, tests/test_manual_docs.py, tests/test_mineru_runner_paths.py, tests/test_project_metadata.py, tests/test_readme.py, tests/test_release_pipeline.py, tests/test_security_policy.py, tests/test_service.py, tests/test_synthetic_paths.py, tests/test_workflow_runtime_env.py, tests/test_workflow_security.py, tests/test_workflows.py, tests/conftest.py
문서/설정/워크플로우/커버리지 검증, docstring 감사, 릴리스 파이프라인 검증, 워크플로우 보안/재현성 강제화, 경로/환경 변수 테스트.

예상 코드 검토 노력

🎯 3 (중간) | ⏱️ ~25분

관련 가능성이 있는 PR

제안된 레이블

github_actions, documentation, testing, ci

🐰 품질의 문이 열렸네요
CI와 docstring이 춤을 추고
백 퍼센트 커버리지 아래
워크플로우가 조화로운 합창을
부르네요, 모두 함께!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 20.18% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed PR 제목은 변경 사항의 주요 목표인 초기 0.1.0 릴리스 changelog 메타데이터 준비를 명확하게 요약합니다.
Description check ✅ Passed PR 설명은 요약, 검증 단계를 포함하며 Git Flow 대상 브랜치 정보가 명확합니다.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch release/v0.1.0

Comment @coderabbitai help to get the list of available commands and usage tips.

@seonghobae

Copy link
Copy Markdown
Collaborator Author

@coderabbitai resolve

@seonghobae

Copy link
Copy Markdown
Collaborator Author

@coderabbitai approve

@seonghobae

Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@seonghobae
seonghobae enabled auto-merge (squash) April 9, 2026 11:37
@coderabbitai

coderabbitai Bot commented Apr 9, 2026

Copy link
Copy Markdown
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai

coderabbitai Bot commented Apr 9, 2026

Copy link
Copy Markdown
✅ Actions performed

Comments resolved and changes approved.

1 similar comment
@coderabbitai

coderabbitai Bot commented Apr 9, 2026

Copy link
Copy Markdown
✅ Actions performed

Comments resolved and changes approved.

@seonghobae

Copy link
Copy Markdown
Collaborator Author

PR #21 is superseded by focused release metadata PR #22, which carried the same changelog change into main without the dirty merge state caused by prior squash history.

@seonghobae seonghobae closed this Apr 9, 2026
auto-merge was automatically disabled April 9, 2026 11:42

Pull request was closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant