feat: migrations #1120

rubiin · 2025-08-12T10:47:52Z

Pull Request

Description

as discussed on the discussion #1119

Please read these instructions and remove unnecessary text.

Try to include a summary of the changes and which issue is fixed.
Also include relevant motivation and context (if applicable).
Make sure to make PR against dev and not the master
List any dependencies that are required for this change. (e.g., packages or other PRs)
Provide a link if there is an issue related to this pull request. e.g., Fixes # (issue)
Please add Reviewers, Assignees, Labels, Projects, and Milestones to the PR. (if applicable)

Type of change

Please put an x in the boxes that apply:

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation update (non-breaking change; modified files are limited to the documentations)
Technical debt (a code change that does not fix a bug or add a feature but makes something clearer for devs)
Other (provide details below)

Checklist

Please put an x in the boxes that apply:

Screenshots

(if appropriate)

Additional context

Add any other context about the problem here.

…#1076) # Pull Request ## Description Please read these instructions and remove unnecessary text. - Try to include a summary of the changes and which issue is fixed. - Also include relevant motivation and context (if applicable). - Make sure to make PR against dev and not the master - List any dependencies that are required for this change. (e.g., packages or other PRs) - Provide a link if there is an issue related to this pull request. e.g., Fixes # (issue) - Please add Reviewers, Assignees, Labels, Projects, and Milestones to the PR. (if applicable) ## Type of change Please put an `x` in the boxes that apply: - [ ] **Bug fix** (non-breaking change which fixes an issue) - [ ] **New feature** (non-breaking change which adds functionality) - [ ] **Breaking change** (fix or feature that would cause existing functionality to not work as expected) - [x] **Documentation update** (non-breaking change; modified files are limited to the documentations) - [ ] **Technical debt** (a code change that does not fix a bug or add a feature but makes something clearer for devs) - [ ] **Other** (provide details below) ## Checklist Please put an `x` in the boxes that apply: - [x] I have read the [CONTRIBUTING](https://github.com/HyDE-Project/HyDE/blob/master/CONTRIBUTING.md) document. - [x] My code follows the code style of this project. - [x] My commit message follows the [commit guidelines](https://github.com/HyDE-Project/HyDE/blob/master/COMMIT_MESSAGE_GUIDELINES.md). - [ ] My change requires a change to the documentation. - [ ] I have updated the documentation accordingly. - [ ] I have added a changelog entry. - [ ] I have added necessary comments/documentation to my code. - [ ] I have added tests to cover my changes. - [x] I have tested my code locally and it works as expected. - [x] All new and existing tests passed. ## Screenshots (if appropriate) ## Additional context Add any other context about the problem here.

github-actions · 2025-08-12T10:47:59Z

⚠️ Warning: PR targeting master branch detected!

This PR is targeting master but should target dev instead.

According to our Quarterly Release Policy:

All pull requests must be submitted to the dev branch
Changes go through dev first for testing before being merged to master during quarterly release windows (1st & 3rd Fridays)
PRs to master are only allowed for emergencies

Required Action:

Change the base branch from master to dev
Follow the pull request template

If this is an emergency fix, please add a comment explaining why it needs to target master directly.

This is an automated message enforcing our quarterly release workflow.

kRHYME7 · 2025-08-12T11:03:38Z

How will the migration scripts trigger and not trigger? will it always trigger?

kRHYME7 · 2025-08-12T11:05:50Z

This won't solve issues when users do not update for a while. But this should solve issues for anyone religiously following the update so this is Good for now.

kRHYME7 · 2025-08-12T11:08:03Z

Can you point this pr to master please.

rubiin · 2025-08-12T11:24:20Z

How will the migration scripts trigger and not trigger? will it always trigger?

this will always trigger on the updates. will find the latest migration based on the name (sorted by date on descending ) and run it

amit-0i · 2025-08-12T11:27:03Z

what if we name migration scripts to HyDE's cal-ver? we can compare the current and new hyde versions with hyde-shell --version

rubiin · 2025-08-12T11:27:12Z

See

rubiin · 2025-08-12T11:27:36Z

what if we name migration scripts to HyDE's cal-ver? we can compare the current and new hyde versions with hyde-shell --version

can do as long as its sortable.

Copilot

Pull Request Overview

This PR implements a migration system for HyDE to handle automated updates and configuration changes during restoration. The migration system will execute the latest migration script found in a new migrations directory when the restore flag is enabled.

Adds migration system infrastructure with automatic execution during restoration
Updates Chinese keybinding documentation with improved translations and path corrections
Adds JSON schema reference to the main configuration file

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File	Description
migrations/20250815.sh	Creates example migration script that reloads Hyde shell shaders
Source/assets/keybinds/KEYBINDINGS.zh.md	Updates Chinese documentation with better translations and corrected file paths
Scripts/install.sh	Integrates migration system into installation script for restore operations
Configs/.config/hyde/config.toml	Adds JSON schema reference for configuration validation

Scripts/install.sh

migrations/20250815.sh

Co-authored-by: Copilot <[email protected]>

github-actions · 2025-08-12T12:55:55Z

⚠️ Warning: PR targeting master branch detected!

This PR is targeting master but should target dev instead.

According to our Quarterly Release Policy:

All pull requests must be submitted to the dev branch
Changes go through dev first for testing before being merged to master during quarterly release windows (1st & 3rd Fridays)
PRs to master are only allowed for emergencies

Required Action:

Change the base branch from master to dev
Follow the pull request template

If this is an emergency fix, please add a comment explaining why it needs to target master directly.

This is an automated message enforcing our quarterly release workflow.

github-actions · 2025-08-12T13:06:31Z

⚠️ Warning: PR targeting master branch detected!

This PR is targeting master but should target dev instead.

According to our Quarterly Release Policy:

All pull requests must be submitted to the dev branch
Changes go through dev first for testing before being merged to master during quarterly release windows (1st & 3rd Fridays)
PRs to master are only allowed for emergencies

Required Action:

Change the base branch from master to dev
Follow the pull request template

If this is an emergency fix, please add a comment explaining why it needs to target master directly.

This is an automated message enforcing our quarterly release workflow.

rubiin · 2025-08-12T13:06:48Z

LGTM

github-actions · 2025-08-12T13:23:56Z

⚠️ Warning: PR targeting master branch detected!

This PR is targeting master but should target dev instead.

According to our Quarterly Release Policy:

All pull requests must be submitted to the dev branch
Changes go through dev first for testing before being merged to master during quarterly release windows (1st & 3rd Fridays)
PRs to master are only allowed for emergencies

Required Action:

Change the base branch from master to dev
Follow the pull request template

If this is an emergency fix, please add a comment explaining why it needs to target master directly.

This is an automated message enforcing our quarterly release workflow.

zerokaze420 and others added 17 commits August 5, 2025 17:12

fix (doc)Synchronize updates from Chinese documents to English documents

2e83b16

Merge branch 'dev' into dev

8316583

Merge branch 'dev' into dev

95d5076

pr

6eb6aef

pr

96b95eb

Merge branch 'rc' into dev

18129da

Merge branch 'master' into rc

f0052f0

Merge branch 'rc' into dev

302c504

fix: add schema on config.toml

53126c7

Merge branch 'dev' into rubiin-patch-1

1a7c53b

fix: add schema on config.toml (#1113)

9be58a6

Merge branch 'master' into rc

759c90f

Merge branch 'rc' into dev

b235cdf

Merge branch 'dev' into dev

f39ca8e

feat: migrations

9be1ab1

feat: migration step

ca90165

rubiin changed the base branch from master to dev August 12, 2025 10:48

Merge branch 'dev' into migrations

f3288f9

rubiin changed the base branch from dev to master August 12, 2025 11:24

rubiin requested a review from Copilot August 12, 2025 12:52

Copilot AI reviewed Aug 12, 2025

View reviewed changes

Scripts/install.sh Outdated Show resolved Hide resolved

Scripts/install.sh Outdated Show resolved Hide resolved

Scripts/install.sh Outdated Show resolved Hide resolved

migrations/20250815.sh Outdated Show resolved Hide resolved

fix: Update Scripts/install.sh

f76ca64

Co-authored-by: Copilot <[email protected]>

fix: Improve migration file detection in install script

14cb9d5

use calver

f90db76

kRHYME7 merged commit 218e8fe into master Aug 12, 2025
4 checks passed

kRHYME7 deleted the migrations branch August 12, 2025 13:25

Uh oh!

feat: migrations #1120

feat: migrations #1120

Uh oh!

Conversation

rubiin commented Aug 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request

Description

Type of change

Checklist

Screenshots

Additional context

Uh oh!

github-actions bot commented Aug 12, 2025

Uh oh!

kRHYME7 commented Aug 12, 2025

Uh oh!

kRHYME7 commented Aug 12, 2025

Uh oh!

kRHYME7 commented Aug 12, 2025

Uh oh!

rubiin commented Aug 12, 2025

Uh oh!

amit-0i commented Aug 12, 2025

Uh oh!

rubiin commented Aug 12, 2025

Uh oh!

rubiin commented Aug 12, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Aug 12, 2025

Uh oh!

github-actions bot commented Aug 12, 2025

Uh oh!

rubiin commented Aug 12, 2025

Uh oh!

github-actions bot commented Aug 12, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

rubiin commented Aug 12, 2025 •

edited

Loading