diff --git a/content/3.client/5.upgrade.md b/content/3.client/5.upgrade.md index 7172ef5..a5ccb81 100644 --- a/content/3.client/5.upgrade.md +++ b/content/3.client/5.upgrade.md @@ -4,28 +4,16 @@ title: 'Update guide' # Keeping your instance synced -Keeping your instance up-to-date with the latest features and bug fixes can enhance your instance's functionality and ensure it stays current. When updates are released, you have the option to adopt them using either one of the guides. Below, you willl find a manual and an automatic guide for updating your instance. - -## Manual update - -You can manually update by executing the following commands at the root of your instance: - -```bash -git remote add movie-web https://github.com/movie-web/movie-web.git -git fetch movie-web -# Change `dev` to `master` if you want a stable experience -git merge movie-web/dev --allow-unrelated-histories -git push -f # Force push to your origin main branch -``` +Keeping your instance up-to-date with the latest features and bug fixes can enhance your instance's functionality and ensure it stays current. When updates are released, you have the option to adopt them using either one of the guides. Below is a automatic and an manual guide on updating your instance. ## Automatic update You can also setup a scheduled workflow to automatically update your instance. This will allow you to keep your instance up to date without manual intervention. To do this, you will need to follow the guide below... - -1. Create a personal access token and add to repository's secret as `PAT` -2. Paste the below file into your repository's root `/.github/workflows` directory +1. If you have not already, click [here](https://github.com/movie-web/movie-web/fork) to fork the movie-web Github repository. +2. Create a [personal access token](https://docs.catalyst.zoho.com/en/tutorials/githubbot/java/generate-personal-access-token) and add to [repository's secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository) as `PAT` +3. Paste the below file into your repository's root `/.github/workflows` directory ```yaml # File: .github/workflows/sync.yml @@ -45,20 +33,30 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - - run: gh repo sync reponame/forkname + - run: gh repo sync / env: GH_TOKEN: ${{ github.token }} - uses: gautamkrishnar/keepalive-workflow@v1 ``` -::alert{type="info"} -This workflow yaml file was taken from this [Github repository](https://github.com/repo-sync/github-sync). -:: -3. Replace the source_repo, source_branch and destination_branch with the correct values for your repository. -4. Commit and push the changes to your repository. +4. Replace the `` placeholder with the GitHub username of the account that owns the fork. +5. Replace the `` placeholder with the repository name of your fork. +6. Commit and push the changes to your repository. Your instance should now be automatically updated to the latest version. +## Manual update + +You can manually update by executing the following commands in the root directory of the repository you have created: + +```bash +git remote add movie-web https://github.com/movie-web/movie-web.git +git fetch movie-web +# Change `dev` to `master` if you want a stable experience +git merge movie-web/dev --allow-unrelated-histories +git push -f # Force push to your origin main branch +``` + # Upgrade version ## From `3.X` to `4.X`