Mirror of https://github.com/roostorg/osprey
github.com/roostorg/osprey
[Docs] add bootstrap release policy and CHANGELOG (#152)
+47
+10
CHANGELOG.md
+10
CHANGELOG.md
···
1
+
# Changelog
2
+
3
+
All notable changes to Osprey will be documented in this file.
4
+
5
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+
## [Unreleased]
9
+
10
+
(No changes yet. Add entries here before cutting a release.)
+37
docs/DEVELOPMENT.md
+37
docs/DEVELOPMENT.md
···
135
135
136
136
[More about rules →](rules.md)
137
137
138
+
## Release Process
139
+
140
+
Osprey uses [Semantic Versioning](https://semver.org/) (SemVer) with a 1.x.y series. This is a lightweight, bootstrap release process so downstream users can depend on version tags instead of commit hashes. The process may evolve as project usage grows.
141
+
142
+
### Patch releases (1.x.y)
143
+
144
+
Patch releases are backward-compatible fixes or small improvements already merged to `main`.
145
+
146
+
Cut a patch release when:
147
+
148
+
- Downstream users need a stable version tag, or
149
+
- Meaningful fixes have accumulated and CI is green
150
+
151
+
There is no fixed cadence; releases are event-driven.
152
+
153
+
### Patch release checklist
154
+
155
+
Before cutting a release:
156
+
157
+
- [ ] Code quality CI passing on `main` (see [Code Quality Checks](https://github.com/roostorg/osprey/actions))
158
+
- [ ] No breaking changes
159
+
- [ ] [CHANGELOG.md](../CHANGELOG.md) updated (if applicable)
160
+
161
+
### How to cut a release
162
+
163
+
1. Ensure the checklist above is satisfied.
164
+
2. In GitHub: **Releases** → **Draft a new release**.
165
+
3. Choose or create a tag `X.Y.Z` (e.g. `1.0.1`) from `main`.
166
+
4. Publish the release.
167
+
168
+
Publishing the release triggers existing automation:
169
+
170
+
- **osprey-rpc**: build and attach sdist (and zip) to the release ([release-osprey-rpc](https://github.com/roostorg/osprey/blob/main/.github/workflows/release-osprey-rpc.yml)).
171
+
- **Osprey Coordinator**: build and push Docker image to GHCR with version tags ([publish-coordinator-image](https://github.com/roostorg/osprey/blob/main/.github/workflows/publish-coordinator-image.yml)).
172
+
173
+
Downstreams can depend on version tags (e.g. `1.0.1`) instead of commit SHAs.
174
+
138
175
## Test Data
139
176
140
177
Generate sample JSON actions: