Clean public release docs
This commit is contained in:
@@ -11,5 +11,6 @@ obj/
|
||||
# Local editor and OS metadata.
|
||||
.vs/
|
||||
.vscode/
|
||||
.local/
|
||||
Thumbs.db
|
||||
Desktop.ini
|
||||
|
||||
@@ -8,7 +8,7 @@ Download the current release:
|
||||
|
||||
[Open the releases page](https://git.gesis.org/seimelan/opencode_gesis/-/releases)
|
||||
|
||||
Download `GESIS-OpenCode-Installer.exe` from the latest release and open it.
|
||||
Download the `.exe` installer from the latest release and open it.
|
||||
|
||||
Windows may show a warning because the installer is not code-signed. If you downloaded it from this GESIS GitLab project, choose **More info** and then **Run anyway**.
|
||||
|
||||
@@ -34,7 +34,7 @@ Do not share your API key with anyone.
|
||||
|
||||
## Install
|
||||
|
||||
1. Open `GESIS-OpenCode-Installer.exe`.
|
||||
1. Open the downloaded installer.
|
||||
2. Paste your API key.
|
||||
3. Click **Check API key**.
|
||||
4. Select the models you want to use in OpenCode. All available models are selected by default.
|
||||
|
||||
-36
@@ -1,36 +0,0 @@
|
||||
# Release and Versioning Rules
|
||||
|
||||
This project uses simple internal release tags:
|
||||
|
||||
```text
|
||||
v<number>
|
||||
```
|
||||
|
||||
Do not use semantic version tags such as `vX.Y.Z`.
|
||||
|
||||
The current public release is `v1`.
|
||||
|
||||
## Hard Rules
|
||||
|
||||
- A new version tag must only be created when the distributable `GESIS-OpenCode-Installer.exe` has changed.
|
||||
- A new version tag must only be created after explicit approval from the project owner.
|
||||
- Do not create a new tag just to change documentation, metadata, release notes, CI files, or GitLab release-page configuration.
|
||||
- Do not create a new tag just because a previous tag needs a GitLab Release page. Attach the release page to the existing tag instead.
|
||||
- Never skip numbers or create speculative tags.
|
||||
- Never delete or move an already-published tag unless the project owner explicitly asks for it.
|
||||
|
||||
## Release Checklist
|
||||
|
||||
1. Rebuild `GESIS-OpenCode-Installer.exe` from the current source.
|
||||
2. Verify the EXE opens and the installer workflow still works.
|
||||
3. Verify the installer still resolves the latest OpenCode Desktop release at runtime.
|
||||
4. Verify no private API key or SSH private key is present in tracked files.
|
||||
5. Commit the changed source and EXE.
|
||||
6. Ask the project owner to approve the next version number.
|
||||
7. Create the next approved simple tag.
|
||||
8. Push `main` and the approved tag.
|
||||
9. If needed, create or update the GitLab Release page for that exact tag.
|
||||
|
||||
## Current Policy
|
||||
|
||||
The current release tag is the authoritative downloadable version. GitLab Release pages must point to an existing approved tag and must not cause a new tag by themselves.
|
||||
Reference in New Issue
Block a user