Skip to content

armgit / floci

Public Imported from GitHub
0

Light, fluffy, and always free - The AWS Local Emulator alternative

chore(release): make CHANGELOG.md automation-owned (#2138)

Hector Venturacc6e96de694a
diff --git a/.coderabbit.yaml b/.coderabbit.yaml
deleted file mode 100644
index 37b175d327..0000000000
--- a/.coderabbit.yaml
+++ /dev/null
@@ -1,59 +0,0 @@
-reviews:
- poem: false
- sequence_diagrams: true
- auto_review:
- drafts: false
- base_branches:
- - main
- path_filters:
- - "!**/target/**"
- - "!**/*.lock"
- - "!compatibility-tests/sdk-test-*/target/**"
- path_instructions:
- - path: "docs/services/*.md"
- instructions: |
- Verify the operation count listed for this service matches the row in
- docs/services/index.md. Counts come from controller dispatch handlers
- (not @Path annotation totals), so one @Path can serve multiple AWS
- operations via query-string or header markers. If a new operation is
- added to the table, check the corresponding Java handler exists in
- src/main/java/io/github/hectorvent/floci/services/.
- - path: "src/main/java/io/github/hectorvent/floci/services/**/*Controller.java"
- instructions: |
- When adding a new @Path handler or AWS operation branch:
- 1. Check that the corresponding docs/services/{service}.md Supported
- Operations table and the row in docs/services/index.md are updated
- in the same PR. The repo has a history of doc drift; flag any new
- operation that lacks a docs update.
- 2. Verify error responses map to the correct AWS error code, HTTP
- status, and wire format (XML for S3/SQS/SNS/IAM, JSON for most
- others). Real AWS clients parse these strictly.
- 3. Flag any shared mutable state (static fields, singleton beans,
- in-memory stores) that is not thread-safe. Prefer ConcurrentHashMap
- or explicit synchronization.
- - path: "CHANGELOG.md"
- instructions: |
- Generated/maintained via semantic-release. Skip review of formatting
- and content; only flag entries that reference non-existent commits or
- issue numbers.
- - path: "compatibility-tests/sdk-test-*/**/*Test.java"
- instructions: |
- Prefer reusing fixtures from TestFixtures.java over duplicating setup
- inline. Flag hard-coded credentials, region strings, or endpoint URLs
- that should live in shared helpers.
- - path: "pom.xml"
- instructions: |
- Review dependency changes for version conflicts, transitive upgrades,
- and license compatibility. Flag new dependencies without clear
- justification. Ensure the Quarkus BOM drives version alignment for
- Quarkus extensions rather than pinning individual versions.
- - path: "**/Dockerfile*"
- instructions: |
- Prefer multi-stage builds, pinned base image tags (never :latest),
- and minimal final layers. Flag any RUN steps that could be combined
- or that leave package manager caches in the image.
- - path: "**/*.sh"
- instructions: |
- Flag unquoted variable expansions, missing `set -euo pipefail`, and
- portability issues. shellcheck runs automatically but add context on
- intent where a warning is intentionally suppressed.
diff --git a/.github/workflows/changelog-guard.yml b/.github/workflows/changelog-guard.yml
new file mode 100644
index 0000000000..0c683d9978
--- /dev/null
+++ b/.github/workflows/changelog-guard.yml
@@ -0,0 +1,25 @@
+name: Changelog Guard
+
+# CHANGELOG.md is generated by semantic-release (the Release Cut workflow) —
+# a contributor's Conventional Commit message IS the changelog entry, so PRs
+# must not edit the file by hand. Genuine corrections (typos in history,
+# security notes) are allowed by adding the `changelog-edit` label to the PR.
+
+on:
+ pull_request:
+ types: [opened, synchronize, reopened, labeled, unlabeled]
+ paths:
+ - 'CHANGELOG.md'
+
+permissions: {}
+
+jobs:
+ guard:
+ name: CHANGELOG.md is generated
+ runs-on: ubuntu-latest
+ if: ${{ !contains(github.event.pull_request.labels.*.name, 'changelog-edit') }}
+ steps:
+ - name: Reject hand edits
+ run: |
+ echo "::error::CHANGELOG.md is generated by semantic-release — your Conventional Commit message is the changelog entry. Remove the CHANGELOG.md changes from this PR, or ask a maintainer for the 'changelog-edit' label if this is a genuine correction."
+ exit 1
diff --git a/.releaserc.json b/.releaserc.json
index 71b1071956..1dc43a09a6 100644
--- a/.releaserc.json
+++ b/.releaserc.json
@@ -1,13 +1,16 @@
{
"tagFormat": "${version}",
- "branches": ["main"],
+ "branches": [
+ "main"
+ ],
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
[
"@semantic-release/changelog",
{
- "changelogFile": "CHANGELOG.md"
+ "changelogFile": "CHANGELOG.md",
+ "changelogTitle": "# Changelog\n\nEntries in this file are generated by [semantic-release](https://github.com/semantic-release/semantic-release) from Conventional Commit messages — do not edit it by hand; your commit message is the changelog entry. Historic sections at the bottom were maintained by hand in the Keep a Changelog format."
}
],
[
@@ -19,10 +22,13 @@
[
"@semantic-release/git",
{
- "assets": ["pom.xml", "CHANGELOG.md"],
+ "assets": [
+ "pom.xml",
+ "CHANGELOG.md"
+ ],
"message": "chore(release): ${nextRelease.version}\n\n${nextRelease.notes}"
}
],
"@semantic-release/github"
]
-}
\ No newline at end of file
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 52ac8b98b7..1e6ef6523f 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,21 +1,6 @@
# 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.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-### Added
-
-- **release:** one-button releases — new "Release Cut" workflow (`workflow_dispatch`, with a dry-run option) runs semantic-release from `main`: bumps `pom.xml`, writes `CHANGELOG.md`, commits, tags, and creates the GitHub Release; the tag then triggers the existing publishing workflow. `release/x.y.x` branches are retired for now
-- **release:** versioned images are now also published to Amazon ECR Public (`public.ecr.aws/floci/floci:x.y.z`, `latest`, `x.y.z-compat`, `latest-compat`), mirroring the nightly ECR Public publishing
-- **apigateway:** support the reserved `floci:override-id` tag on `CreateRestApi` (v1) and `CreateApi` (v2) to pin the generated API ID, unifying custom IDs with the tag KMS and Cognito already use. Override keys are stripped from the returned tags, validated (non-blank, no whitespace/control characters and no `/`, `?`, `#`) and rejected on `TagResource` with `BadRequestException`, which is what both services declare. The older API-Gateway-specific `_custom_id_` tag still works as a deprecated fallback and is now stripped too; `floci:override-id` wins when both are present. Creating an API whose override ID already exists in the region is rejected with `ConflictException` (409) instead of overwriting the existing API ([#1593](https://github.com/floci-io/floci/pull/1593))
-
-### Changed
-
-- **apigateway:** `_custom_id_` is no longer persisted in the tags returned for a REST API. It was previously echoed back as a normal tag.
+Entries in this file are generated by [semantic-release](https://github.com/semantic-release/semantic-release) from Conventional Commit messages — do not edit it by hand; your commit message is the changelog entry. Historic sections at the bottom were maintained by hand in the Keep a Changelog format.
## [1.5.34] - 2026-07-28
@@ -1267,7 +1252,6 @@ Initial public release of Floci — a fast, free, open-source local AWS emulator
---
-[Unreleased]: https://github.com/floci-io/floci/compare/1.5.33...HEAD
[1.5.33]: https://github.com/floci-io/floci/compare/1.5.32...1.5.33
[1.5.31]: https://github.com/floci-io/floci/compare/1.5.31...1.5.32
[1.5.31]: https://github.com/floci-io/floci/compare/1.5.30...1.5.31
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index cd9eed5fa2..7bf0731608 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -54,7 +54,6 @@ Floci uses a **tag-driven release model**. Docker images are never published on
| Branch | Purpose | Docker published? |
|---|---|---|
| `main` | Integration branch — all PRs merge here. Treated as unstable/nightly. | No (CI tests only) |
-| `release/x.y.x` | Stable line for a minor version. Receives cherry-picked fixes from `main`. | No (CI tests only) |
| `X.Y.Z` tag | Signals a production release. Triggers the full Docker publish pipeline. | Yes (`x.y.z`, `latest`, `x.y.z-jvm`, `latest-jvm`) |
## Commit Message Format
@@ -160,34 +159,16 @@ Docker images are never built on contributor PRs, so merging to `main` is always
## Release Process (maintainers)
-### New minor or major release
+Releases are cut from `main` with the **Release Cut** workflow
+(Actions → Release Cut → Run workflow). semantic-release analyzes the
+Conventional Commits since the last tag, bumps `pom.xml`, regenerates
+`CHANGELOG.md`, commits, tags, and publishes the GitHub Release; the tag
+push triggers the Docker publish pipeline. Use the `dry-run` input to
+preview the next version and notes without releasing.
-```bash
-# 1. Create a release branch from main
-git checkout main && git pull
-git checkout -b release/1.2.x
-
-# 2. Push — the semver.yml workflow runs semantic-release automatically,
-# bumps the version, updates CHANGELOG.md + pom.xml, and pushes tag 1.2.0.
-git push origin release/1.2.x
-
-# 3. The tag push triggers the Docker publish pipeline.
-```
-
-### Patch release on an existing line
-
-```bash
-git checkout release/1.1.x
-git cherry-pick <commit-sha>
-git push origin release/1.1.x
-# semver workflow creates 1.1.x and triggers Docker publish
-```
-
-### Hotfix
-
-1. Fix on `main` via the normal PR process.
-2. Cherry-pick the merge commit onto the relevant `release/x.y.x` branch and push.
-3. If the bug only affects a release branch, open a PR directly against that branch.
+`CHANGELOG.md` is generated — **do not edit it by hand**. Your Conventional
+Commit message is the changelog entry. Genuine corrections to the file
+require the `changelog-edit` label on the PR.
## Testing Policy for Pull Requests