containers / containers/oci-delta

Follow up on no_ostree build tag: README docs and CI coverage

Open
#74 0 comments 0 reactions 0 assignees View on GitHub

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:

  1. README/docs update — the no_ostree build 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).

  2. CI coverage.github/workflows/ci.yml doesn't build or vet with -tags no_ostree. Since the tag relies on ostreerepo_no_ostree.go staying in sync with the DataSource interface and OstreeRepoDataSource'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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.