-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* 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 <[email protected]> * [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 <[email protected]> Co-authored-by: jadentha <[email protected]>
- Loading branch information
Showing
4 changed files
with
53 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/[email protected] | ||
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main'}} | ||
with: | ||
BRANCH: gh-pages | ||
FOLDER: docs | ||
CLEAN: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters