From 8a11125602a74d6c00210ccd5d9df9aa0bb5457c Mon Sep 17 00:00:00 2001 From: alexytomi <60690056+alexytomi@users.noreply.github.com> Date: Tue, 7 Jan 2025 21:57:56 +0800 Subject: [PATCH] Various small fixes (#233) * Return the old method of deploying + README * [BUG-FIX] 'Help us improve this page' goes to the wrong folder * Update INSTALL.md Signed-off-by: jadentha <127716349+jadentha@users.noreply.github.com> * [BUG-FIX] Fix broken link to JIT.md caused by folder restructure * Add legacy deploy option for forks + README I don't think everyone is willing to setup a cloudflare pages nor use npm to locally test their changes so heres the old one bacm --------- Signed-off-by: jadentha <127716349+jadentha@users.noreply.github.com> Co-authored-by: jadentha <127716349+jadentha@users.noreply.github.com> --- .github/workflows/README.md | 19 +++++++++++++++ .github/workflows/deploy(legacy).yml | 31 ++++++++++++++++++++++++ markdown/.vuepress/config.js | 2 +- markdown/wiki/getting_started/INSTALL.md | 4 +-- 4 files changed, 53 insertions(+), 3 deletions(-) create mode 100644 .github/workflows/README.md create mode 100644 .github/workflows/deploy(legacy).yml diff --git a/.github/workflows/README.md b/.github/workflows/README.md new file mode 100644 index 00000000..8590bd02 --- /dev/null +++ b/.github/workflows/README.md @@ -0,0 +1,19 @@ +# Workflows + +`build.yml` - Simply uploads a build artifact of the static website\ +`deploy.yml` - Builds, uploads, and deploys the uploaded artifact to github pages + +# Issues + +You may encounter that the deploy workflow does not work, this is because github pages prefixes a subdirectory with your repository name when deploying. This breaks the static site generated by Vuepress + +Use cloudflare pages instead or test locally with `npm run start` + +### If that is not possible + +`deploy(legacy).yml` - Builds and pushes the static site to the branch `gh-pages`. This stops the automatic subdirectory addition from happening + +This may break other pages that you have deployed and should be avoided if possible. Please use _cloudflare pages_ instead + +If that is not possible, you may edit the `base` property in `config.js` and use `deploy.yml`, this may break asset retrieval (images in our case) +##### Remember to revert this change on the PR branch diff --git a/.github/workflows/deploy(legacy).yml b/.github/workflows/deploy(legacy).yml new file mode 100644 index 00000000..b30c919c --- /dev/null +++ b/.github/workflows/deploy(legacy).yml @@ -0,0 +1,31 @@ +name: Build And Deploy (Legacy [gh-pages]) +on: + push: + branches-ignore: + - gh-pages + workflow_dispatch: + # pull_request: +jobs: + build: + name: Build and Deploy + runs-on: ubuntu-latest + steps: + - name: Checkout Repository + uses: actions/checkout@v2 + with: + fetch-depth: '0' + persist-credentials: false + submodules: 'recursive' + - name: Setup Node + uses: actions/setup-node@v2-beta + with: + node-version: '22' + - name: Build + run: npm install && npm run build + - name: Deploy + uses: JamesIves/github-pages-deploy-action@4.1.5 + if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main'}} + with: + BRANCH: gh-pages + FOLDER: docs + CLEAN: true diff --git a/markdown/.vuepress/config.js b/markdown/.vuepress/config.js index 16341c8a..ccdcfd35 100644 --- a/markdown/.vuepress/config.js +++ b/markdown/.vuepress/config.js @@ -81,7 +81,7 @@ module.exports = { displayAllHeaders: false, lastUpdated: true, repo: "https://github.com/PojavLauncherTeam/PojavLauncherTeam.github.io/", - docsDir: "", + docsDir: "markdown", docsBranch: "main", editLinks: true, editLinkText: "Help us improve this page!", diff --git a/markdown/wiki/getting_started/INSTALL.md b/markdown/wiki/getting_started/INSTALL.md index 3d6d13b2..e691817f 100644 --- a/markdown/wiki/getting_started/INSTALL.md +++ b/markdown/wiki/getting_started/INSTALL.md @@ -66,7 +66,7 @@ Note: **Enable URL Schemes in TrollStore settings.** - 14.0 to 16.6.1 - 17.0 -1. Follow these steps to install [TrollStore](https://github.com/opa334/TrollStore). +1. Follow these steps to install [TrollStore](https://ios.cfw.guide/installing-trollstore/). 2. Download the latest release from [here](https://github.com/PojavLauncherTeam/PojavLauncher_iOS/releases/download/v2.2/net.kdt.pojavlauncher-2.2-ios.ipa). - For a specific release, you can find its package on the [Releases](https://github.com/PojavLauncherTeam/PojavLauncher_iOS/releases) page @@ -87,7 +87,7 @@ PojavLauncher supports being sideloaded with AltStore and SideStore. Instruction 2. Install the latest release using this [Install with AltStore](altstore://install?url=https://github.com/PojavLauncherTeam/PojavLauncher_iOS/releases/latest/download/net.kdt.pojavlauncher.ipa) button. - For a specific release, you can find its button on the [Releases](https://github.com/PojavLauncherTeam/PojavLauncher_iOS/releases) page -Installing PojavLauncher is not the end for Jailed iOS devices. In order to play Minecraft itself, you will need to [enable JIT](./JIT.md). +Installing PojavLauncher is not the end for Jailed iOS devices. In order to play Minecraft itself, you will need to [enable JIT](../faq/ios/JIT.md). ::: ::: details Sideloading (Jailbroken)