Aleksei Sviridkin 90797d9de9 fix(ci): take main's ref for a bare first-party image ref in a drifted file (#5329)
<!-- Thank you for making a contribution! Here are some tips for you:
- Use Conventional Commits for the PR title: `type(scope): description`
- Types: feat, fix, security (a fix that comes through a security
advisory), docs, style, refactor, perf, test, build, ci, chore
- Scopes are not an exhaustive list — pick the most specific scope for
the change and extend the list when a genuinely new area appears.
Examples:
- System components: dashboard, platform, operator, cilium, kube-ovn,
linstor, fluxcd, cluster-api
- Managed apps: postgres, mariadb, redis, kafka, clickhouse,
virtual-machine, kubernetes
- Development and maintenance: api, hack, tests, ci, docs, maintenance
- Breaking changes: append `!` after type/scope (`feat(api)!: ...`) or
add a `BREAKING CHANGE:` footer
- If it's a work in progress, consider creating this PR as a draft.
- Don't hesistate to ask for opinion and review in the community chats,
even if it's still a draft.
- Fixes merged to `main` reach the release lines the backport batch runs
for automatically, so do not open backport PRs by hand:
https://github.com/cozystack/cozystack/blob/main/docs/release/backports.md
-->

## What this PR does

Closes #5328.

A PR whose merge commit predates a config change to
`packages/system/observability-proxy/values.yaml` fails E2E with
`observability-proxy` in `ImagePullBackOff` on
`observability-proxy:v0.0.0`. `hack/overlay-main-images.sh` skips a file
that differs from the `cozystack-packages:main` artifact in anything but
ref lines, so the bare ref committed for a new image stays, and that tag
was never pushed. The merge commit is fixed when the run starts, so a
rerun, or a PR not pushed to since, drifts on files it never touched.
This comes back every time the proxy's `values.yaml` changes on main,
and it will hit every new image the same way until a release stamps its
ref.

### Behavior changes

- In a drifted values file, a bare first-party ref
(`ghcr.io/cozystack/cozystack/<name>:<tag>`, no digest) under an image
key now takes the artifact line with the same key and indentation, a
digest, and the same first-party image (`.../cozystack/<name>`). Exactly
one such line must exist; none or two leave the ref as committed.
- The rest of a drifted file stays as the PR has it, including every
digest-pinned ref. The drift guard still keeps a PR's chart from running
against an image built for a newer one wherever the committed ref pulls.
- Third-party refs are never replaced. Main can bump one together with
its config, and the committed pair is the one known to work.
- The other digest-less first-party refs in the tree get the same
treatment. `backup-http-client:v1.6.0`, `redis-backup:v1.6.0` and
`kubernetes-backup:v1.6.0` in `backupstrategy-controller` (#4264) are
not on ghcr either, so a drifted run could not pull them before and now
can. `migration-controller:latest` does exist; in a drifted file it now
runs main's image with the PR's older config. That is the trade-off: it
is the same component built from the tree, and a digest-less ref is not
reproducible anyway.
- Packages that took main's images this way are named in their own
`Image overlay bare refs` annotation, and the summary line counts them
as `bare-refs=N`. A rewrite that cannot write the file is counted as
`failed`.
- `docs/agents/image-refs.md` now says how PR CI stamps a bare ref in a
drifted file, instead of only promising that it does.

### Not in this PR

- Pinning a real tag+digest for the proxy in `values.yaml`. The only
pushed tags are nightlies, which retention prunes after 14 builds, and
digests pinned on main are not protected from it, so the pin would break
again within weeks. A release tag appears with release-1.8.
- The other digest-less first-party refs from #4264.
- The split shape (`repository:` + `tag:` without `digest:`), a
single-quoted value, or one followed by a `# comment`. No package writes
a bare first-party ref that way today; such a line stays as committed.

### Tests

New cases in `hack/overlay-main-images_test.bats`: a drifted file takes
the artifact ref for its bare ref and keeps its config; a digest-pinned
sibling stays; no replacement for a different image name, for an
artifact line without a digest, for a third-party ref even when main
pins one, for a third-party image with the same name, or for two
candidate lines; a rewrite that cannot write the file is counted as
failed and leaves no temporary file. The suite passes under bats and
under the POSIX runner with `dash`. The script was also run against an
older copy of the proxy's real `values.yaml`: only the `image:` line
changed.

### Screenshots

<!-- REQUIRED for UI changes: attach screenshots or screen recordings
demonstrating
the visual impact of your changes. PRs with UI changes without
screenshots will not be merged. -->

Not a UI change.

### Downstream repositories

<!--
Cozystack is upstream for repositories that are NOT kept in sync with it
automatically, and nothing in CI compares the two sides, so a change
here can break them silently.

Which change forces what, and which file to touch, is the trigger map in
docs/agents/contributing.md under "Downstream Repositories". Walk it
before you tick anything.

IF YOU ARE AN AI AGENT OR AN LLM, THIS IS PART OF THE TASK, NOT A FORM
TO FILL IN:

1. Walk the trigger map against the actual diff of this PR, file by
file. Do not decide from the PR title or from your memory of what you
changed.
2. For every repository you tick, open the follow-up PR there and link
it on the same line. A ticked box with no link claims work that does not
exist, which is worse than an empty box. Search that repository for an
open PR or issue covering it first, and link that instead of filing a
duplicate.
3. When the follow-up is out of scope, or needs a decision that is not
yours to make, open an issue in that repository instead, link that, and
say so in the PR body. Do not push a speculative PR into another
repository just to fill a line here.
4. Do not tick "No downstream repository is affected" to make the
checklist go away. If you are unsure, leave every box empty and say so
in the PR body, so a human decides.
-->

- [x] No downstream repository is affected by this change
- [ ] [cozystack/website](https://github.com/cozystack/website) -
follow-up:
- [ ]
[cozystack/terraform-provider-cozystack](https://github.com/cozystack/terraform-provider-cozystack)
- follow-up:
- [ ]
[cozystack/ansible-cozystack](https://github.com/cozystack/ansible-cozystack)
- follow-up:
- [ ] [cozystack/ccp](https://github.com/cozystack/ccp) - follow-up:
- [ ] [cozystack/talm](https://github.com/cozystack/talm) - follow-up:
- [ ] [cozystack/cozyhr](https://github.com/cozystack/cozyhr) -
follow-up:
- [ ] [cozystack/cozy-proxy](https://github.com/cozystack/cozy-proxy) -
follow-up:
- [ ]
[cozystack/cozystack-telemetry-server](https://github.com/cozystack/cozystack-telemetry-server)
- follow-up:
- [ ]
[cozystack/external-apps-example](https://github.com/cozystack/external-apps-example)
- follow-up:
- [ ] [cozystack/examples](https://github.com/cozystack/examples) -
follow-up:
- [ ] [cozystack/community](https://github.com/cozystack/community) -
follow-up:

The diff touches `hack/overlay-main-images.sh`, its bats file and one
paragraph of `docs/agents/image-refs.md`. Nothing under `hack/` moves or
is renamed and no make target changes (the ccp trigger), and no package,
values key, CRD or naming changes.

### Release note

<!--  Write a release note:
- Explain what has changed internally and for users.
- Start with the same `type(scope):` prefix as in the PR title
- Follow the guidelines at
https://github.com/kubernetes/community/blob/master/contributors/guide/release-notes.md.
-->

```release-note
fix(ci): a PR behind main no longer installs a never-pushed placeholder tag for a new first-party image, such as observability-proxy:v0.0.0, when that package's values.yaml changed on main since the PR's merge commit.
```


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

<!-- coderabbit-ai-generated:v1 -->

## Summary by CodeRabbit

* **Documentation**
* Clarified that PR CI may update eligible, digest-less first-party
image references while preserving other committed configuration.
Third-party references retain their committed tags and digests.
* **Bug Fixes**
* Image references are left unchanged when a matching current-main image
is missing or ambiguous, and failed file updates are reported.
* **Tests**
* Added coverage for reference matching, unchanged configuration, and
failed updates.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-11-14 20:15:52 +03:00
2025-10-08 09:43:34 +05:00
2024-02-08 12:04:32 +01:00

Cozystack Cozystack

GitHub Release Apache-2.0 License Commit activity OpenSSF Best Practices OpenSSF Scorecard CLOMonitor Support

Cozystack

Cozystack is a free and open-source platform and framework for building clouds.

Cozystack is a CNCF Sandbox project that was originally built and sponsored by Ænix.

With Cozystack, you can transform a bunch of servers into an intelligent system with a simple REST API for spawning Kubernetes clusters, Database-as-a-Service, virtual machines, load balancers, HTTP caching services, and other services with ease.

Use Cozystack to build your own cloud or provide a cost-effective development environment.

Cozystack user interface

Use-Cases

Documentation

The documentation is located on the cozystack.io website.

Read the Getting Started section for a quick start.

If you encounter any difficulties, start with the troubleshooting guide and work your way through the process that we've outlined.

Versioning

Versioning adheres to the Semantic Versioning principles.
A full list of the available releases is available in the GitHub repository's Release section.

Contributions

Contributions are highly appreciated and very welcomed!

In case of bugs, please check if the issue has already been opened by checking the GitHub Issues section. If it isn't, you can open a new one. A detailed report will help us replicate it, assess it, and work on a fix.

You are welcome to take on the fix yourself. Commits are used to generate the changelog, and their author will be referenced in it.

If you have a concrete feature request, open an issue. For a cross-cutting or architectural change, open a design proposal in the community repo. For questions or early ideas, use GitHub Discussions. See CONTRIBUTING.md for the full routing.

Community

You are welcome to join us in #cozystack, on either CNCF Slack (get an invite) or Kubernetes Slack (get an invite), in our Telegram group, and at our community meetings. Add them to your Google Calendar or iCal for convenience.

Project documents

Document What it covers
Governance How decisions are made and who makes them
Contributor Ladder How to grow from contributor to maintainer
Maintainers Who maintains the project
Code of Conduct What we expect of each other
Security Policy Reporting a vulnerability, and which releases get fixes
Adopters Who runs Cozystack in production
Roadmap Where the project is going

License

Cozystack is licensed under Apache 2.0.
The code is provided as-is with no warranties.

Commercial Support

A list of companies providing commercial support for this project can be found on official site.

Languages
Go 52%
Shell 34%
TypeScript 6.8%
Go Template 4.7%
Makefile 1.3%
Other 1.1%