chore: add snap-in version upgrade compatibility doc #147
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,136 @@ | ||||||
| This section outlines the compatibility rules when upgrading snap-in versions. These rules determine what changes are allowed in a patch upgrade. | ||||||
|
|
||||||
| ## Connections | ||||||
| - New optional connections can be added. | ||||||
| - New required connections cannot be added. | ||||||
| - Existing connections can be removed. | ||||||
| - For existing connections: | ||||||
| - Description can be changed. | ||||||
| - Display name can be changed. | ||||||
| - New keyring types can be added. | ||||||
| - Existing keyring types cannot be removed. | ||||||
| - Optional connections cannot be made required. | ||||||
| - Required connections can be made optional. | ||||||
|
|
||||||
| ## Event Sources | ||||||
|
|
||||||
| - New event sources cannot be added. | ||||||
|
There was a problem hiding this comment. We can add new event sources |
||||||
| - Existing event sources cannot be removed. | ||||||
| - For existing event sources: | ||||||
| - Description can be changed. | ||||||
| - Display name can be changed. | ||||||
| - Type cannot be changed. | ||||||
| - Connection can be removed but cannot be changed. | ||||||
| - Source config can be changed (test changes thoroughly). | ||||||
|
|
||||||
| - Setup instructions can be changed. | ||||||
| - Function can be changed. | ||||||
|
|
||||||
| ## Tags | ||||||
| - New tags can be added. | ||||||
| - Existing tags cannot be removed. | ||||||
| - For existing tags: | ||||||
| - Description can be changed. | ||||||
|
|
||||||
| ## Automations | ||||||
| - Full flexibility - can be added, removed, or modified. | ||||||
| - Description can be changed. | ||||||
| - Source can be changed. | ||||||
| - Allowed event types can be changed. | ||||||
| - Function to execute can be changed. | ||||||
|
|
||||||
| ## Hooks | ||||||
| - New hook types can be added. | ||||||
| - Existing hook types can be removed. | ||||||
| - Function to execute can be changed. | ||||||
|
|
||||||
| ## Functions | ||||||
| - Full flexibility - can be added, removed, or modified. | ||||||
| - All properties can be changed. | ||||||
|
|
||||||
| ## Commands | ||||||
| - Full flexibility - can be added, removed, or modified. | ||||||
| - All properties can be changed. | ||||||
|
|
||||||
| ## Snap Kit Actions | ||||||
|
|
||||||
| - Can be removed | ||||||
|
There was a problem hiding this comment. 🚫 [EkLine] reported by reviewdog 🐶
Suggested change
|
||||||
| - For existing snap kit actions: | ||||||
| - Description can be changed. | ||||||
| - Function can be changed. | ||||||
|
|
||||||
| ## Snap Components | ||||||
|
|
||||||
| - Can be removed | ||||||
|
There was a problem hiding this comment. 🚫 [EkLine] reported by reviewdog 🐶
Suggested change
|
||||||
| - For existing snap components: | ||||||
| - Display name can be changed. | ||||||
| - Description can be changed. | ||||||
| - Surface cannot be changed. | ||||||
| - Snap kit action name can be changed. | ||||||
| - Snap kit body can be changed. | ||||||
| - Initializer can be changed. | ||||||
|
|
||||||
| ## Service Account | ||||||
|
|
||||||
| - Display name can be changed. | ||||||
| - Description can be changed. | ||||||
|
There was a problem hiding this comment. We cannot set description from the manifest |
||||||
|
|
||||||
| ## Inputs (Global Variables) | ||||||
|
|
||||||
| - Can be added or removed. | ||||||
| - For existing inputs: | ||||||
| - Type cannot be changed. | ||||||
| - All other properties can be modified. | ||||||
|
|
||||||
| ## Imports | ||||||
| - New imports can be added. | ||||||
| - Existing imports cannot be removed. | ||||||
| - For existing imports: | ||||||
| - Display name can be changed. | ||||||
| - Description can be changed. | ||||||
| - Function cannot be changed. | ||||||
|
|
||||||
| - New allowed keyring types can be added. | ||||||
| - Existing allowed keyring types cannot be removed. | ||||||
| - Function name can be changed. | ||||||
|
|
||||||
| - Loader function cannot be removed once set. | ||||||
|
|
||||||
| ## User Level Keyrings | ||||||
|
|
||||||
| - New keyrings can be added. | ||||||
|
There was a problem hiding this comment. We don't allow required user level keyrings |
||||||
| - Existing keyrings can be removed. | ||||||
| - For existing keyrings: | ||||||
| - Description can be changed. | ||||||
| - Display name can be changed. | ||||||
| - New allowed types can be added. | ||||||
| - Existing allowed types cannot be removed. | ||||||
| - Required keyrings can be made optional. | ||||||
|
|
||||||
| ## User Level Inputs | ||||||
|
|
||||||
| - Can be added or removed. | ||||||
| - For existing inputs: | ||||||
| - Type cannot be changed. | ||||||
| - All other properties can be modified. | ||||||
|
|
||||||
| ## Keyring Types | ||||||
|
|
||||||
| - Can be added or removed. | ||||||
| - For existing keyring types: | ||||||
|
There was a problem hiding this comment. @SathishKumarHS Please check There was a problem hiding this comment.
|
||||||
| - Name can be changed. | ||||||
| - Description can be changed. | ||||||
| - Scopes can be changed. | ||||||
| - Scope delimiter can be changed. | ||||||
| - Authorize, refresh, and revoke functions can be changed. | ||||||
| - Organization data can be changed. | ||||||
| - External service name can be changed. | ||||||
| - Kind cannot be changed. | ||||||
| - Keyring type template cannot be changed. | ||||||
| - OAuth secret ID cannot be changed. | ||||||
|
|
||||||
| ## Functions Build Config | ||||||
|
There was a problem hiding this comment. Remove this section. Build config is not documented |
||||||
| - Full flexibility - can be added, removed, or modified. | ||||||
| - All properties can be changed. | ||||||
|
|
||||||
| ## Configuration Handler | ||||||
|
|
||||||
| - Full flexibility - can be added, removed, or modified. | ||||||
| - All properties can be changed. | ||||||
|
|
||||||
| ## Operations | ||||||
| - New operations can be added. | ||||||
| - Existing operations cannot be removed. | ||||||
| - For existing operations: | ||||||
| - Operation type cannot be changed. | ||||||
| - Input ports cannot be changed (including type and schema). | ||||||
| - Output ports cannot be changed (including type and schema). | ||||||
| - Keyring types follow the same rules as Connections. | ||||||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's rename it to
allowed_connection_typesor what is present in the manifest.Keyring Typeshave a different meaning