Fix upgrade guide and add warning

This commit is contained in:
William Oldham
2024-03-31 17:02:53 +01:00
parent b172b52723
commit 4c81431dda

View File

@@ -11,22 +11,29 @@ Keeping your instance up-to-date with the latest features and bug fixes can enha
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. 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... To do this, you will need to follow the guide below...
1. If you have not already, click [here](https://github.com/movie-web/movie-web/fork) to fork the movie-web Github repository.
2. Paste the below file into your repository's root `/.github/workflows` directory
```yaml <Warning>This upgrade method will only work if your repository is a fork!</Warning>
# File: .github/workflows/sync.yml
name: Sync fork
permissions: <Steps>
<Steps.Step>
If you have not already, click [here](https://github.com/movie-web/movie-web/fork) to fork the movie-web Github repository.
</Steps.Step>
<Steps.Step>
Paste the below file into your repository's root `/.github/workflows` directory
```yaml
# File: .github/workflows/sync.yml
name: Sync fork
permissions:
contents: write contents: write
on: on:
schedule: schedule:
- cron: "0 0 * * *" - cron: "0 0 * * *"
workflow_dispatch: workflow_dispatch:
jobs: jobs:
sync: sync:
name: Sync fork name: Sync fork
runs-on: ubuntu-latest runs-on: ubuntu-latest
@@ -42,9 +49,12 @@ jobs:
GH_TOKEN: ${{ github.token }} GH_TOKEN: ${{ github.token }}
- uses: gautamkrishnar/keepalive-workflow@v1 - uses: gautamkrishnar/keepalive-workflow@v1
``` ```
</Steps.Step>
3. Commit and push the changes to your repository. <Steps.Step>
Commit and push the changes to your repository.
</Steps.Step>
</Steps>
Your instance should now be automatically updated to the latest version. Your instance should now be automatically updated to the latest version.