Skip to content

Commit

Permalink
add official sync description file
Browse files Browse the repository at this point in the history
  • Loading branch information
cici090 committed Aug 18, 2024
1 parent 24a7078 commit badec40
Show file tree
Hide file tree
Showing 4 changed files with 79 additions and 2 deletions.
36 changes: 36 additions & 0 deletions OFFICIAL_SYNC.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Sync with Official Releases

We are committed to providing our users with a reliable and continuously optimized Kit, so we will keep in close sync with the official release, and whenever a new official version is released, we will quickly update it to ensure that our Kit will always include the latest features, fixes, and improvements. Additionally, we conduct regular compatibility tests and performance optimizations based on the official release cadence to ensure you get the best experience possible. Whether it's the introduction of new features or security enhancements, you can rest assured that you can rely on us to stay consistent and on the cutting edge with the official release.

## process description

1. get the latest npm version to compare

2. if inconsistent, select the latest tag with version number to compare and get the patch file
a. get all tags
b. select the tags to compare
c. get the patch file

3. parse patch and compare tonconnect react update content

4. if only package.json version and tonconnect ui version have changed

5. pull our package file and update these fields
a. pull the latest code
b. update package.json

6. create a new branch and commit the changes

7. merge the branch into main

8. trigger github action to automatically update log and publish to npm

9. after successful merge, remove the created branch

10. if the patch contains more than just version updates, create an issue to be notified
a. if the patch contains other significant changes, create an issue on github to be notified about the updates

11. if any request fails after step 3, create an issue, making sure there is only one issue per problem


![Official_Sync_Process_Flowchart_image](./public/official_sync_process_flowchart.png)
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ You can find more details and the protocol specification in the [docs](https://d
## Installation with npm
`yarn add @townsquarelabs/ui-vue`

# Sync with Official Releases
This [OFFICIAL_SYNC.md](./OFFICIAL_SYNC.md) file describes how we synchronize with the official


# Usage

## Add TonConnectUIProvider
Expand Down Expand Up @@ -377,3 +381,40 @@ Alternatively, you can include the polyfill via CDN by adding the following scri
```

Both methods will provide a fallback implementation of the Web Animations API and should resolve the animation issues you are facing.

# Sync with Official Releases

We are committed to providing our users with a reliable and continuously optimized Kit, so we will keep in close sync with the official release, and whenever a new official version is released, we will quickly update it to ensure that our Kit will always include the latest features, fixes, and improvements. Additionally, we conduct regular compatibility tests and performance optimizations based on the official release cadence to ensure you get the best experience possible. Whether it's the introduction of new features or security enhancements, you can rest assured that you can rely on us to stay consistent and on the cutting edge with the official release.

## process description

1. get the latest npm version to compare

2. if inconsistent, select the latest tag with version number to compare and get the patch file
a. get all tags
b. select the tags to compare
c. get the patch file

3. parse patch and compare tonconnect react update content

4. if only package.json version and tonconnect ui version have changed

5. pull our package file and update these fields
a. pull the latest code
b. update package.json

6. create a new branch and commit the changes

7. merge the branch into main

8. trigger github action to automatically update log and publish to npm

9. after successful merge, remove the created branch

10. if the patch contains more than just version updates, create an issue to be notified
a. if the patch contains other significant changes, create an issue on github to be notified about the updates

11. if any request fails after step 3, create an issue, making sure there is only one issue per problem


![Official_Sync_Process_Flowchart_image](./public/official_sync_process_flowchart.png)
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@townsquarelabs/ui-vue",
"private": false,
"version": "2.0.9",
"version": "2.0.10-beta.0",
"type": "module",
"scripts": {
"dev": "vite",
Expand Down Expand Up @@ -63,7 +63,7 @@
}
},
"dependencies": {
"@tonconnect/ui": "2.0.9",
"@tonconnect/ui": "2.0.10-beta.0",
"@vitejs/plugin-vue": "^5.0.5",
"@vue/composition-api": "^1.7.2",
"axios": "^0.27.2",
Expand Down
Binary file added public/official_sync_process_flowchart.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit badec40

Please sign in to comment.