Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rename back to --json-fd and unhide #1182

Closed
wants to merge 1 commit into from

Conversation

antheas
Copy link
Contributor

@antheas antheas commented Mar 8, 2025

We will use this PR going forward until the API stabilizes.

If the option is hidden, it cannot be used. The option being called --json-fd and under our control gives you the option to change the API once more before the next release (this PR should not be merged).

The rename also saves me from having to deal with the drift of migrating to the new version while the old version is still deployed.

Closes: #1181

Signed-off-by: Antheas Kapenekakis <[email protected]>
@cgwalters
Copy link
Collaborator

If the option is hidden, it cannot be used.

I hope this is addressed with my suggestion of parsing --version.

The option being called --json-fd and under our control gives you the option to change the API once more before the next release (this PR should not be merged).

Can you clarify: Are you filing this just to track that you plan to ship a branch of bootc with this patch? If so, sure sounds fine, but maybe we then close this?

Alternatively, while I think --progress-fd is a clearer and better name than --json-fd for the rationale described in the commit message I'd be tentatively fine to re-add --json-fd as an alias for --progress-fd so we don't break users who are testing it out now (not to mention the docs, etc).

@antheas
Copy link
Contributor Author

antheas commented Mar 8, 2025

Yes, I'm filing this to track this. We will ship this patch instead for the time being so that the existing updater can work with few changes

If I made progress fd visible it would be a bit messy if you change the protocol in the next version

Unfortunately, this means we will still be shipping a fork

Bootc has been failing in some updates recently so we need to bump it. Rechunk ostree-rs-ext bump might also introduce other regressions with the old version

In regards to which name is better, I would tend towards just --progress and using fd 0, but that would require a logging framework change

@antheas
Copy link
Contributor Author

antheas commented Mar 8, 2025

I should also mention that we should ship an updated version now, and the next bootc version would take a while to trickle through Fedora even if we decided on a change. So I came up with this PR to shortcut this and buy us some time.

@antheas antheas closed this Mar 8, 2025
@cgwalters
Copy link
Collaborator

the next bootc version would take a while to trickle through Fedora even if we decided on a change.

There is https://copr.fedorainfracloud.org/coprs/rhcontainerbot/bootc/ that auto-builds from git main FWIW.

@antheas
Copy link
Contributor Author

antheas commented Mar 8, 2025

Interesting. We currently ship a fork, but I would like to fallback to the normal bootc package so we do not have to maintain that. The --progress-fd option being hidden does not inspire confidence and would need to be timed. So i opted for the rename for now.

If there are any quirks with the API I think we should stabilize that soon and since the option being hidden means it is not stable we get a bit of a chance to touch things up.

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.

--progress-fd being hidden makes it unusable
2 participants