Skip to content

build: document releases and adopt Changie - #268

Open
ffumero2003 wants to merge 4 commits into
masterfrom
release-standard-conformance
Open

ffumero2003 wants to merge 4 commits into
masterfrom
release-standard-conformance

Conversation

@ffumero2003

@ffumero2003 ffumero2003 commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Context

Release preparation needs a reproducible changelog and a documented path from version selection to Maven Central verification.

Changes

  • Add RELEASE.md with release milestones, Changie/version updates, build and local health-check commands, signed tagging, deployment, verification, and recovery steps.
  • Migrate 20 published changelog sections and five unreleased entries to Changie without rewriting the published notes. New PRs add fragments; batching updates the changelog and gradle.properties together.
  • Add the changelog-check CI job and tests for release-note extraction and changelog/version consistency.

This is the first of two stacked changes. Deployment controls follow in #269. Maven Central publication, artifact signing, and Sonatype staging configuration are unchanged.

Verification

  • ./gradlew build --no-daemon passed.
  • Thirteen release metadata/Changie tests passed, including a real disposable batch/merge, generated-file checks, a narrow Dependabot workflow-update exemption, and tag commands in a fresh shell with only TAG exported.
  • The documented local health check returned SDKHARNESS_RESULT health golden-path PASS - against a disposable loopback simulator.
  • The publishing task graph passed with --dry-run and placeholder credentials; signing, publishing, and staging close/release tasks were skipped. This does not validate production credentials or publish artifacts.
  • actionlint passed for the new changelog workflow; published changelog sections were checked against the originals.

Closes #266

@ffumero2003

Copy link
Copy Markdown
Contributor Author

Snyk Code (code/snyk) — 6 findings triaged as false positives

The SAST check reports 6 newly introduced issues in the release tooling (scripts/release.py, scripts/tests/test_release.py). All six are false positives in this context:

  • Command Injection (CWE-78) ×3 — release.py:45, release.py:51, test_release.py:137. These subprocess.run calls use list-form arguments with no shell=True; the flagged "environment variable" is the Changie executable path (e.g. [changie, "merge"]), not a shell string. With no shell there is no command string to inject — the env var only selects which trusted binary to invoke.
  • Path Traversal (CWE-23) ×3 — release.py:42-48 (shutil.copy / copytree). The flagged input is a maintainer-supplied command-line argument to a local release script run by maintainers and CI, not untrusted external input crossing a trust boundary.

These are local release/test scripts executed by trusted operators and CI with trusted inputs; none of the flagged flows is an untrusted trust boundary. code/snyk is not a required status check on this repository, so it does not gate merge. The findings are being dismissed in Snyk as false positives with this rationale.

This branch has not been deployed

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document and automate release preparation with Changie

1 participant