docs/user/versioning: Document APIs covered by our Semantic Versioning #935
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
openshift-ci-robot
added
size/M
wking
commented
Dec 18, 2018
docs/user/overview.md
Outdated
Member
Author
There was a problem hiding this comment.
Changing "target" -> "asset" here gets us closer to the wording we use for --dir.
Contributor
^^ @crawford |
openshift-ci-robot
added
the
needs-rebase
Contributor
|
Can you rebase this so we can get this in? |
Member
Author
Rebased onto master with a017e43 -> 8df754a. |
Also roll the tips-and-tricks docs into the overview's multi-invocation docs, since they'd been covering the same ground with slightly different wording before. I've expanded the unified description to go into a bit more detail and tie in the new versioning docs. I've also documented the manifest-templates target from 166a9f1 (pkg/asset: new target manifest-templates, 2018-10-30, openshift#592). And I've shifted a few "target directory" references to "asset directory", since that's the language we use for --dir (as shown by --help).
openshift-ci-robot
removed
the
needs-rebase
Member
Author
|
Prow seemed hung ("shellcheck Expected — Waiting for status to be reported" and similar), so I've pushed 8df754a -> 28592d0 with a new commit date. |
Contributor
|
/approve |
Member
Author
|
/retest |
Member
Author
|
Finally all green :). |
Contributor
|
/lgtm |
Contributor
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: crawford, wking The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
wking
added a commit
to wking/openshift-installer
that referenced
this pull request
Jan 5, 2019
Through eb781ff (Merge pull request openshift#935 from wking/api-stability, 2019-01-04).
wking
added a commit
to wking/openshift-installer
that referenced
this pull request
Oct 1, 2019
I'd added these in 28592d0 (docs/user/versioning: Document APIs covered by our Semantic Versioning, 2018-12-17, openshift#935). But v0.16.1 was the last installer release. Since then, OpenShift tooling picks whatever the most recent commit is in the appropriate release-* branch when building releases, so we don't have a way to set the SemVer versions on the command-line API that the removed document depends on. We will attempt to preserve any command-line API that occurs in official documentation, but we can no longer make formal SemVer statements about breaking compat.
jhixson74
pushed a commit
to jhixson74/installer
that referenced
this pull request
Dec 6, 2019
I'd added these in 28592d0 (docs/user/versioning: Document APIs covered by our Semantic Versioning, 2018-12-17, openshift#935). But v0.16.1 was the last installer release. Since then, OpenShift tooling picks whatever the most recent commit is in the appropriate release-* branch when building releases, so we don't have a way to set the SemVer versions on the command-line API that the removed document depends on. We will attempt to preserve any command-line API that occurs in official documentation, but we can no longer make formal SemVer statements about breaking compat.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Also roll the tips-and-tricks docs into the overview's multi-invocation docs, since they'd been covering the same ground with slightly different wording before. I've expanded the unified description to go into a bit more detail and tie in the new versioning docs.
I've also documented the
manifest-templatestarget from 166a9f1 (#592).CC @smarterclayton, @derekwaynecarr, @eparis.