containers / containers/oci-delta
Follow up on no_ostree build tag: README docs and CI coverage
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 21
- Forks
- 14
- Avg merge
- 6h 10m
- Merged PRs (30d)
- 9
Description
Follow-up to #73, which added the no_ostree build tag (go build -tags no_ostree / make build-no-ostree) so oci-delta can be built without the libostree/ostree-devel dependency.
Two gaps to close:
-
README/docs update — the
no_ostreebuild mode isn't documented anywhere user-facing (README.md, CONTRIBUTING.md, man page). Add a short section explaining what it does, how to build with it, and what functionality is unavailable (apply --ostree-repo). -
CI coverage —
.github/workflows/ci.ymldoesn't build or vet with-tags no_ostree. Since the tag relies onostreerepo_no_ostree.gostaying in sync with theDataSourceinterface andOstreeRepoDataSource's method set, an untested build path can silently break if either changes. Add a CI step (or job) that runs:go build -tags no_ostree ./...go vet -tags no_ostree ./...
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with README.md, CONTRIBUTING.md, the man page, and .github/workflows/ci.yml, then review the existing no_ostree build-tag files and the commands from issue #73. Document the build mode, its unavailable ostree-repo functionality, and add CI coverage for the specified build and vet commands. Done means the documentation is user-facing and both no_ostree checks pass in CI.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, go
- Domain
- build-system, ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100