Skip to content

docs(examples): 🔥 remove the AEGISS migration example - #5

Merged
robertodr merged 1 commit into
mainfrom
docs/drop-aegiss-example
Oct 28, 2026
Merged

robertodr merged 1 commit into
mainfrom
docs/drop-aegiss-example

Conversation

@robertodr

Copy link
Copy Markdown
Member

🤖 AI text below 🤖

Summary

examples/aegiss/ showed how to migrate a repository that had its own copies of release.py and cliff.toml. AEGISS never had those copies on main: Algorithmiq/AEGISS#103 adopted release-tools v1.0.0 directly. Compared with AEGISS's main:

  • release.yml, backport.yml and pr-checks.yml were identical, but deploy.yml had already drifted (a header comment).
  • justfile.diff was already applied; docs.diff and deploy.yml.diff no longer applied.
  • The settings steps in its README (renaming the PR checks after the migration) didn't apply, because AEGISS used the PR checks / … names from the start.

A snapshot of another repository's files is the kind of copy release-tools exists to remove, and AEGISS isn't public, so it can't serve as a public reference either. examples/stubs/ already covers every consumer file, including a full deploy.yml.

This PR removes:

  • examples/aegiss/, and its mention in the README;
  • test_aegiss_stub_is_the_consumer_stub in tests/test_examples.py;
  • the ubuntu-26.04 runner label in .github/actionlint.yaml, which only examples/aegiss used. The ignore for job.workflow_* stays.

Checklist

  • just lint and just test pass
  • README.md updated if the stubs, inputs or setup changed
  • Breaking change or deprecation: the Migration section says what consumers must change (not applicable)

examples/aegiss described migrating a repository from its own copies of
release.py and cliff.toml, but AEGISS adopted release-tools directly
(Algorithmiq/AEGISS#103), so its diffs no longer apply and its deploy.yml had
already drifted. examples/stubs covers every consumer file, deploy.yml
included. The test comparing the AEGISS stubs and the actionlint runner
label they needed go with it.

Assisted-by: Pi:claude-opus-5-5
@robertodr
robertodr merged commit 9bfee6d into main Oct 28, 2026
4 checks passed
@robertodr
robertodr deleted the docs/drop-aegiss-example branch October 28, 2026 13:53
robertodr pushed a commit that referenced this pull request Oct 28, 2026
Merging this PR releases **v1.1.0**.

It is updated automatically whenever a change lands on `release/1.1`.
Wording fixes to `CHANGELOG.md` can be pushed to this PR, but make them
just before merging: the next update overwrites them.

---


## 1.1.0 (2026-10-28)

### Features

- **changelog:** Link each entry to its PR
([#6](#6))

### Documentation

- **readme:** Describe the release process here instead of the internal
guide ([#4](#4))
- **examples:** Remove the AEGISS migration example
([#5](#5))

Co-authored-by: algorithmiq-release-bot[bot] <349245065+algorithmiq-release-bot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant