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

apiage: ability to promote apis tracked in JSON from preview to stable #761

Merged
merged 2 commits into from
Sep 12, 2022

Conversation

phlogistonjohn
Copy link
Collaborator

Depends on #759

Fixes: #760

The intended workflow is to update the Go source code and then run make api-promote which will detect the changes to the ceph_preview tag(s) in
the sources and then promote apis from preview to stable in the
tracking json.

I explicitly do not want apiage.py (or the makefile) to make changes to
the source code. The contributor may or may not want to make changes
incrementally, also some times a preview function may be moved to
another source file. Plus, I simply think this is a job for a human.
But we can avoid having to edit the JSON and markdown files afterward.

@phlogistonjohn phlogistonjohn changed the title Jjm stable promoter apiage: ability to promote apis tracked in JSON from preview to stable Aug 22, 2022
@dpulls
Copy link

dpulls bot commented Aug 30, 2022

🎉 All dependencies have been resolved !

@mergify
Copy link

mergify bot commented Aug 30, 2022

This pull request now has conflicts with the target branch. Could you please resolve conflicts and force push the corrected changes? 🙏

@phlogistonjohn phlogistonjohn marked this pull request as ready for review August 31, 2022 14:06
@anoopcs9
Copy link
Collaborator

anoopcs9 commented Sep 7, 2022

@Mergifyio rebase

Promote an API from preview to stable, after the build tags are removed
from the Go source code. This mode can be used to help move apis that
are now stable out of preview state in our api-status.json file.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
The intended workflow is to update the Go source code and then run `make
api-promote` which will detect the changes to the ceph_preview tag(s) in
the sources and then promote apis from preview to stable in the
tracking json.

I explicitly do not want apiage.py (or the makefile) to make changes to
the source code. The contributor may or may not want to make changes
incrementally, also some times a preview function may be moved to
another source file. Plus, I simply think this is a job for a human.
But we can avoid having to edit the JSON and markdown files afterward.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
@mergify
Copy link

mergify bot commented Sep 7, 2022

rebase

✅ Branch has been successfully rebased

Copy link
Collaborator

@ansiwen ansiwen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@ansiwen ansiwen added the no-API This PR does not include any changes to the public API of a go-ceph package label Sep 12, 2022
@mergify mergify bot merged commit 2390f2c into ceph:master Sep 12, 2022
@phlogistonjohn phlogistonjohn deleted the jjm-stable-promoter branch September 12, 2022 18:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-API This PR does not include any changes to the public API of a go-ceph package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

apiage: add a mode for detecting changed build tags and updating api stablity
3 participants