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

Breaking change support policy #308

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Conversation

corranrogue9
Copy link
Collaborator

No description provided.

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 53f7455:

💡 Validation status: suggestions

File Status Preview URL Details
Odata-docs/resources/version-lifecycle.md 💡Suggestion View Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/resources/support.md ✅Succeeded View

Odata-docs/resources/version-lifecycle.md

  • Line 2, Column 1: [Suggestion: description-missing - See documentation] Missing required attribute: 'description'.

Odata-docs/TOC.yml

  • Line 294, Column 17: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 496, Column 13: [Suggestion: link-broken - See documentation] Link '/odata/resources/version-lifecycle' points to a page that doesn't exist. Check the path or URL and update the link.

For more details, please refer to the build report.

Note: Links can become broken if there are changes on the target sites. If you think the validation result is a false alarm, please use SiteHelp with option 'Content authoring and publishing -> False alarm on broken link validation' to report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit a1d9369:

💡 Validation status: suggestions

File Status Preview URL Details
Odata-docs/resources/version-lifecycle.md 💡Suggestion View Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/resources/support.md ✅Succeeded View

Odata-docs/resources/version-lifecycle.md

  • Line 2, Column 1: [Suggestion: description-missing - See documentation] Missing required attribute: 'description'.

Odata-docs/TOC.yml

  • Line 294, Column 17: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 336, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/edm/set-annotations-schema' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 500, Column 13: [Suggestion: link-broken - See documentation] Link '/odata/resources/version-lifecycle' points to a page that doesn't exist. Check the path or URL and update the link.

For more details, please refer to the build report.

Note: Links can become broken if there are changes on the target sites. If you think the validation result is a false alarm, please use SiteHelp with option 'Content authoring and publishing -> False alarm on broken link validation' to report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit bb5f1ec:

💡 Validation status: suggestions

File Status Preview URL Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/resources/support.md ✅Succeeded View
Odata-docs/resources/version-lifecycle.md ✅Succeeded View

Odata-docs/TOC.yml

  • Line 294, Column 17: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 336, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/edm/set-annotations-schema' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 500, Column 13: [Suggestion: link-broken - See documentation] Link '/odata/resources/version-lifecycle' points to a page that doesn't exist. Check the path or URL and update the link.

For more details, please refer to the build report.

Note: Links can become broken if there are changes on the target sites. If you think the validation result is a false alarm, please use SiteHelp with option 'Content authoring and publishing -> False alarm on broken link validation' to report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 584ac46:

💡 Validation status: suggestions

File Status Preview URL Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/resources/support.md ✅Succeeded View
Odata-docs/resources/version-lifecycle.md ✅Succeeded View

Odata-docs/TOC.yml

  • Line 336, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/edm/set-annotations-schema' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 500, Column 13: [Suggestion: link-broken - See documentation] Link '/odata/resources/version-lifecycle' points to a page that doesn't exist. Check the path or URL and update the link.

For more details, please refer to the build report.

Note: Links can become broken if there are changes on the target sites. If you think the validation result is a false alarm, please use SiteHelp with option 'Content authoring and publishing -> False alarm on broken link validation' to report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit fb00903:

💡 Validation status: suggestions

File Status Preview URL Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/resources/support.md ✅Succeeded View
Odata-docs/resources/version-lifecycle.md ✅Succeeded View

Odata-docs/TOC.yml

  • Line 294, Column 17: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 336, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/edm/set-annotations-schema' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 500, Column 13: [Suggestion: link-broken - See documentation] Link '/odata/resources/version-lifecycle' points to a page that doesn't exist. Check the path or URL and update the link.

For more details, please refer to the build report.

Note: Links can become broken if there are changes on the target sites. If you think the validation result is a false alarm, please use SiteHelp with option 'Content authoring and publishing -> False alarm on broken link validation' to report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 11531d8:

⚠️ Validation status: warnings

File Status Preview URL Details
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ⚠️Warning n/a (file deleted or renamed) Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded View
Odata-docs/resources/support.md ✅Succeeded View
Odata-docs/resources/version-lifecycle.md ✅Succeeded View

Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md

  • [Warning: file-not-redirected - See documentation] File Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md with URL /odata/odatalib/using-ut8jsonwriter-for-better-performance was deleted without redirection. To avoid broken links, add a redirection.

Odata-docs/TOC.yml

  • Line 294, Column 17: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 336, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/edm/set-annotations-schema' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 500, Column 13: [Suggestion: link-broken - See documentation] Link '/odata/resources/version-lifecycle' points to a page that doesn't exist. Check the path or URL and update the link.

For more details, please refer to the build report.

Note: Links can become broken if there are changes on the target sites. If you think the validation result is a false alarm, please use SiteHelp with option 'Content authoring and publishing -> False alarm on broken link validation' to report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 7fc0866:

⚠️ Validation status: warnings

File Status Preview URL Details
⚠️Warning Details
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ⚠️Warning n/a (file deleted or renamed) Details
.openpublishing.redirection.json 💡Suggestion View Details
Odata-docs/TOC.yml 💡Suggestion View Details
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded
Odata-docs/resources/support.md ✅Succeeded View
Odata-docs/resources/version-lifecycle.md ✅Succeeded View

  • Line 0, Column 0: [Warning: redirected-file-not-removed - See documentation] Redirected file 'odatalib/v7/using-utf8jsonwriter-for-better-performance.md' are still in the repo. After adding a file to the redirection JSON file, you must delete the original file from the repo.

Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md

  • [Warning: file-not-redirected - See documentation] File Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md with URL /odata/odatalib/using-ut8jsonwriter-for-better-performance was deleted without redirection. To avoid broken links, add a redirection.

.openpublishing.redirection.json

  • Line 5, Column 88: [Suggestion: redirect-url-invalid - See documentation] Can't redirect document ID for redirected file 'odatalib/v7/using-utf8jsonwriter-for-better-performance.md' because redirect URL '/odata/odatalib/using-ut8jsonwriter-for-better-performance' is invalid or is in a different docset. Specify a redirect_url in the same docset, or set redirect_document_id to false in .openpublishing.redirection.json.

Odata-docs/TOC.yml

  • Line 294, Column 17: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 336, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/edm/set-annotations-schema' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 500, Column 13: [Suggestion: link-broken - See documentation] Link '/odata/resources/version-lifecycle' points to a page that doesn't exist. Check the path or URL and update the link.

For more details, please refer to the build report.

Note: Links can become broken if there are changes on the target sites. If you think the validation result is a false alarm, please use SiteHelp with option 'Content authoring and publishing -> False alarm on broken link validation' to report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 549d67e:

💡 Validation status: suggestions

File Status Preview URL Details
Odata-docs/TOC.yml 💡Suggestion View Details
.openpublishing.redirection.json ✅Succeeded View
Odata-docs/odatalib/v7/using-ut8jsonwriter-for-better-performance.md ✅Succeeded n/a (file deleted or renamed)
Odata-docs/odatalib/v7/using-utf8jsonwriter-for-better-performance.md ✅Succeeded View
Odata-docs/resources/support.md ✅Succeeded View
Odata-docs/resources/version-lifecycle.md ✅Succeeded View

Odata-docs/TOC.yml

  • Line 294, Column 17: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/using-utf8jsonwriter-for-better-performance' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 336, Column 15: [Suggestion: link-broken - See documentation] Link '/odata/odatalib/edm/set-annotations-schema' points to a page that doesn't exist. Check the path or URL and update the link.
  • Line 500, Column 13: [Suggestion: link-broken - See documentation] Link '/odata/resources/version-lifecycle' points to a page that doesn't exist. Check the path or URL and update the link.

For more details, please refer to the build report.

Note: Links can become broken if there are changes on the target sites. If you think the validation result is a false alarm, please use SiteHelp with option 'Content authoring and publishing -> False alarm on broken link validation' to report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:


Nuget packages published by the [OData nuget profile](https://www.nuget.org/profiles/OData) will have the following actions taken to mitigate the accidental release of a library version that introduces a breaking change:
1. The package will be marked deprecated.
2. The deprecated package will specify an alternate version to install (usually `Latest`) with a message indicating what the breaking change was.

Choose a reason for hiding this comment

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

Should we specify if we'll introduce a link to the github release with the description?

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.

2 participants