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.

Sign up for GitHub

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

Jump to bottom

Add developer guidance for API changes to CustomRuns #6567

Merged
merged 1 commit into from
Apr 20, 2023
Merged

Add developer guidance for API changes to CustomRuns #6567

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api_compatibility_policy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,4 +155,4 @@ but a change that renames the Go struct type for that field is allowed.
## Notes for Developers

Are you a Tekton contributor looking to make a backwards incompatible change?
Read more on additional considerations at [deprecations.md](./docs/developers/deprecations.md).
Read more on additional considerations at [api-changes.md](./docs/developers/api-changes.md#deprecations).
11 changes: 10 additions & 1 deletion docs/developers/deprecations.md → docs/developers/api-changes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
# Deprecations
# API Changes

✋ Before reading this, please read the
[API Compatibility Policy](../../api_compatibility_policy.md)

## CustomRuns

Before adding an optional field to the spec or status of `CustomRun`,
consider whether it could be part of the custom spec or custom status instead.
New fields should be added to the spec or status of the `CustomRun` API only if they
make sense for all custom run controllers to support.

## Deprecations

The following are things developers should keep in mind for deprecations. These
tips may not apply in every case, so use your best judgement! If you're not sure
how these affect your deprecation or timeline, ask the maintainers.
Expand Down