Merge pull request 'ci: fix package publishing + add dev/main packages' (#65) from fix/package-publishing into dev
docker / lint (push) Successful in 31s
docker / test (push) Successful in 30s
lint / lint (push) Successful in 41s
publish / test (push) Successful in 37s
publish / lint (push) Successful in 43s
test / test (push) Successful in 44s
publish / publish (push) Successful in 42s
test / package (push) Successful in 53s
docker / docker (push) Successful in 1m3s
docker / test (pull_request) Successful in 33s
docker / lint (pull_request) Successful in 40s
lint / lint (pull_request) Successful in 43s
test / test (pull_request) Successful in 45s
test / package (pull_request) Successful in 42s
docker / docker (pull_request) Successful in 43s
docker / lint (push) Successful in 31s
docker / test (push) Successful in 30s
lint / lint (push) Successful in 41s
publish / test (push) Successful in 37s
publish / lint (push) Successful in 43s
test / test (push) Successful in 44s
publish / publish (push) Successful in 42s
test / package (push) Successful in 53s
docker / docker (push) Successful in 1m3s
docker / test (pull_request) Successful in 33s
docker / lint (pull_request) Successful in 40s
lint / lint (pull_request) Successful in 43s
test / test (pull_request) Successful in 45s
test / package (pull_request) Successful in 42s
docker / docker (pull_request) Successful in 43s
This commit was merged in pull request #65.
This commit is contained in:
@@ -1,14 +1,15 @@
|
||||
name: publish
|
||||
|
||||
# Build the Python package with uv and publish it to the self-hosted Gitea PyPI
|
||||
# registry on a version tag. Gated on lint + tests so a release can never ship
|
||||
# red. Publishing reuses the existing REGISTRY_TOKEN package secret (the same one
|
||||
# docker.yml uses to push images); if it is absent the job fails loudly instead
|
||||
# of publishing anonymously.
|
||||
# registry on merge. dev -> a dev package (aegis-gitea-mcp-dev, .devN versions);
|
||||
# main -> the stable package (aegis-gitea-mcp). Gated on lint + tests so a release
|
||||
# can never ship red. Reuses the REGISTRY_TOKEN package secret (same one docker.yml
|
||||
# uses); if it is absent the job fails loudly instead of publishing anonymously.
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- 'v*'
|
||||
branches:
|
||||
- dev
|
||||
- main
|
||||
|
||||
jobs:
|
||||
# ---------------------------------------------------------------------------
|
||||
@@ -55,6 +56,13 @@ jobs:
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 3. Build with uv and publish to the Gitea PyPI registry.
|
||||
#
|
||||
# dev -> aegis-gitea-mcp-dev X.Y.Z.dev<run_number> (always unique)
|
||||
# main -> aegis-gitea-mcp X.Y.Z (no-op if already there)
|
||||
#
|
||||
# The package name + version are patched into pyproject.toml at build time
|
||||
# only — never committed. The committed file keeps name "aegis-gitea-mcp"
|
||||
# and version "X.Y.Z".
|
||||
# ---------------------------------------------------------------------------
|
||||
publish:
|
||||
needs: [lint, test]
|
||||
@@ -77,11 +85,37 @@ jobs:
|
||||
REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }}
|
||||
run: |
|
||||
if [ -z "${REGISTRY_TOKEN}" ]; then
|
||||
echo "::error::REGISTRY_TOKEN secret is not set." >&2
|
||||
echo "Configure a PAT with write:package as the REGISTRY_TOKEN Actions secret." >&2
|
||||
echo "::error::REGISTRY_TOKEN secret is not set. Configure a PAT with write:package." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Compute channel (package name + version)
|
||||
id: chan
|
||||
shell: bash
|
||||
run: |
|
||||
BASE="$(grep -E '^version = ' pyproject.toml | head -1 | sed -E 's/^version = "([^"]+)".*/\1/')"
|
||||
if [ "${GITHUB_REF_NAME}" = "main" ]; then
|
||||
PKG_NAME="aegis-gitea-mcp"
|
||||
PKG_VERSION="${BASE}"
|
||||
CHANNEL="stable"
|
||||
else
|
||||
PKG_NAME="aegis-gitea-mcp-dev"
|
||||
PKG_VERSION="${BASE}.dev${GITHUB_RUN_NUMBER}"
|
||||
CHANNEL="dev"
|
||||
fi
|
||||
echo "pkg_name=${PKG_NAME}" >> "$GITHUB_OUTPUT"
|
||||
echo "pkg_version=${PKG_VERSION}" >> "$GITHUB_OUTPUT"
|
||||
echo "channel=${CHANNEL}" >> "$GITHUB_OUTPUT"
|
||||
echo "Publishing ${PKG_NAME} ${PKG_VERSION} (${CHANNEL})"
|
||||
|
||||
- name: Patch package name + version (build only, not committed)
|
||||
shell: bash
|
||||
run: |
|
||||
sed -i -E "s/^name = \".*\"/name = \"${{ steps.chan.outputs.pkg_name }}\"/" pyproject.toml
|
||||
sed -i -E "s/^version = \".*\"/version = \"${{ steps.chan.outputs.pkg_version }}\"/" pyproject.toml
|
||||
echo "--- patched [project] header ---"
|
||||
grep -E '^(name|version) = ' pyproject.toml
|
||||
|
||||
- name: Build sdist + wheel
|
||||
shell: bash
|
||||
run: uv build
|
||||
@@ -93,7 +127,7 @@ jobs:
|
||||
continue-on-error: true
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: dist
|
||||
name: dist-${{ steps.chan.outputs.channel }}
|
||||
path: dist/*
|
||||
|
||||
- name: Publish to Gitea PyPI registry
|
||||
@@ -104,10 +138,13 @@ jobs:
|
||||
# username and the token is the password.
|
||||
REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }}
|
||||
run: |
|
||||
# --check-url makes uv skip files already in the registry, so a main
|
||||
# push that did not bump the version is a clean no-op instead of a 409.
|
||||
uv publish \
|
||||
--publish-url https://git.hiddenden.cafe/api/packages/Hiddenden/pypi \
|
||||
--username "${GITHUB_ACTOR}" \
|
||||
--password "${REGISTRY_TOKEN}"
|
||||
--check-url https://git.hiddenden.cafe/api/packages/Hiddenden/pypi/simple/ \
|
||||
--username "${GITHUB_ACTOR}" \
|
||||
--password "${REGISTRY_TOKEN}"
|
||||
|
||||
# Optional second step to also publish to public PyPI lives behind its own
|
||||
# secret. Intentionally left as a disabled stub — this pass does NOT push
|
||||
|
||||
+53
-18
@@ -1,12 +1,23 @@
|
||||
# Packaging & publishing
|
||||
|
||||
AegisGitea-MCP is distributed as a single Python package, `aegis-gitea-mcp`,
|
||||
built with [`uv`](https://docs.astral.sh/uv/) and published to the self-hosted
|
||||
Gitea package registry.
|
||||
AegisGitea-MCP is built with [`uv`](https://docs.astral.sh/uv/) and published to
|
||||
the self-hosted Gitea package registry on every merge. There are two channels:
|
||||
|
||||
| Channel | Package | Published on | Versioning |
|
||||
|---------|---------|--------------|------------|
|
||||
| **stable** | `aegis-gitea-mcp` | merge to `main` | `X.Y.Z` |
|
||||
| **dev** | `aegis-gitea-mcp-dev` | merge to `dev` | `X.Y.Z.devN` (N = CI run number, always unique) |
|
||||
|
||||
Both channels build from the same source and install the **same import module**,
|
||||
`aegis_gitea_mcp`, with the same two console scripts. They differ only in the
|
||||
distribution name and the version. Install one or the other in a given
|
||||
environment, not both — they would collide on the module.
|
||||
|
||||
## Distribution layout
|
||||
|
||||
One package, two console scripts, one optional extra:
|
||||
Each channel ships one distribution with two console scripts and one optional
|
||||
extra (the stable and dev packages are identical here — only the dist name and
|
||||
version differ):
|
||||
|
||||
| Console script | Entry point | Requires |
|
||||
|----------------|-------------|----------|
|
||||
@@ -39,30 +50,54 @@ GITEA_URL=https://git.hiddenden.cafe GITEA_TOKEN=<pat> \
|
||||
|
||||
## Install from the Gitea registry
|
||||
|
||||
**Stable** (`aegis-gitea-mcp`, published from `main`):
|
||||
|
||||
```bash
|
||||
uv pip install \
|
||||
--index-url https://git.hiddenden.cafe/api/packages/Hiddenden/pypi/simple \
|
||||
--index-url https://git.hiddenden.cafe/api/packages/Hiddenden/pypi/simple/ \
|
||||
aegis-gitea-mcp
|
||||
|
||||
# or run it one-off without installing into the environment:
|
||||
uvx --index https://git.hiddenden.cafe/api/packages/Hiddenden/pypi/simple/ aegis-gitea-mcp
|
||||
```
|
||||
|
||||
(With `pip`, use `--index-url` the same way.)
|
||||
**Dev** (`aegis-gitea-mcp-dev`, published from `dev` — newest pre-release build):
|
||||
|
||||
## Cutting a release
|
||||
```bash
|
||||
uv pip install \
|
||||
--index-url https://git.hiddenden.cafe/api/packages/Hiddenden/pypi/simple/ \
|
||||
aegis-gitea-mcp-dev
|
||||
```
|
||||
|
||||
Releases are tag-driven. The publish workflow
|
||||
(`.gitea/workflows/publish.yml`) triggers on a `v*` tag, runs lint + tests
|
||||
first, builds with `uv`, and publishes to the Gitea PyPI registry.
|
||||
(With `pip`, use `--index-url` the same way.) Both packages expose the same
|
||||
`aegis-gitea-mcp` / `aegis-gitea-mcp-server` console scripts and the same
|
||||
`aegis_gitea_mcp` import module, so install one **or** the other per environment.
|
||||
|
||||
1. Bump `version` in `pyproject.toml` (e.g. `0.2.0`).
|
||||
2. Open a PR into `dev`, merge `dev` into `main`.
|
||||
3. Tag the release commit and push the tag:
|
||||
## Publishing channels
|
||||
|
||||
```bash
|
||||
git tag v0.2.0
|
||||
git push origin v0.2.0
|
||||
```
|
||||
Publishing is merge-driven, not tag-driven. The publish workflow
|
||||
(`.gitea/workflows/publish.yml`) triggers on a push to `dev` or `main`, runs
|
||||
lint + tests first, then builds with `uv` and publishes to the Gitea PyPI
|
||||
registry. The package name + version are patched into `pyproject.toml` **at build
|
||||
time only** (never committed):
|
||||
|
||||
4. The workflow publishes the wheel + sdist and attaches them to the run.
|
||||
- **`dev` push** → `aegis-gitea-mcp-dev` at `X.Y.Z.dev<run_number>`. The CI run
|
||||
number is monotonic, so every merge to `dev` yields a unique pre-release.
|
||||
- **`main` push** → `aegis-gitea-mcp` at the plain `X.Y.Z` from `pyproject.toml`.
|
||||
Publishing uses `uv publish --check-url`, so a `main` push that did **not** bump
|
||||
the version is a clean no-op (the existing files are skipped) rather than a 409.
|
||||
|
||||
### Cutting a stable release
|
||||
|
||||
1. Bump `version` in `pyproject.toml` (e.g. `0.2.0` → `0.3.0`) on a branch off
|
||||
`dev`.
|
||||
2. Open a PR into `dev` and merge it (this publishes a fresh
|
||||
`aegis-gitea-mcp-dev` build).
|
||||
3. Promote `dev` → `main`. The push to `main` publishes the new stable
|
||||
`aegis-gitea-mcp X.Y.Z`.
|
||||
|
||||
Re-pushing `main` at an unchanged version is harmless — `--check-url` skips the
|
||||
already-published files.
|
||||
|
||||
### Required CI secrets
|
||||
|
||||
|
||||
Reference in New Issue
Block a user