Skip to content

Commit a6c7cfe

Browse files
authored
Merge pull request #1 from unraid/feat/pr-template
2 parents 02cfe4b + a0a82d7 commit a6c7cfe

File tree

3 files changed

+68
-0
lines changed

3 files changed

+68
-0
lines changed

.github/pull_request_template.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Before Submitting This PR, Please Ensure You Have Completed The Following:
2+
3+
1. [ ] Are all new documentation files lowercase, with dash separated names (ex. unraid-os.mdx)?
4+
2. [ ] Are all assets (images, etc), located in an assets/ subfolder next to the .md/mdx files?
5+
4. [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change?
6+
5. [ ] Is the build succeeding?

.github/workflows/pr.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Simple workflow for deploying static content to GitHub Pages
2+
name: Build PR
3+
4+
on:
5+
# Runs on pushes targeting the default branch
6+
pull_request:
7+
8+
# Allows you to run this workflow manually from the Actions tab
9+
workflow_dispatch:
10+
11+
jobs:
12+
# Single deploy job since we're just deploying
13+
build:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@v3
18+
- name: Install NPM
19+
uses: actions/setup-node@v2.5.2
20+
with:
21+
version: 19
22+
- name: Cache dependencies
23+
uses: actions/cache@v2
24+
with:
25+
path: ~/.npm
26+
key: npm-${{ hashFiles('package-lock.json') }}
27+
restore-keys: npm-
28+
- name: Install dependencies
29+
run: npm ci
30+
- name: NPM Build
31+
run: npm run build

.github/workflows/static.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,34 @@ jobs:
5555
- name: Deploy to GitHub Pages
5656
id: deployment
5757
uses: actions/deploy-pages@v2
58+
59+
deploy_to_branch:
60+
name: Deploy to GitHub Pages (Branch)
61+
runs-on: ubuntu-latest
62+
steps:
63+
- uses: actions/checkout@v3
64+
- uses: actions/setup-node@v3
65+
with:
66+
node-version: 18
67+
cache: npm
68+
69+
- name: Install dependencies
70+
run: npm install --frozen-lockfile
71+
- name: Build website
72+
run: npm build
73+
74+
# Popular action to deploy to GitHub Pages:
75+
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
76+
- name: Deploy to GitHub Pages
77+
uses: peaceiris/actions-gh-pages@v3
78+
with:
79+
github_token: ${{ secrets.GITHUB_TOKEN }}
80+
# Build output to publish to the `gh-pages` branch:
81+
publish_dir: ./build
82+
# The following lines assign commit authorship to the official
83+
# GH-Actions bot for deploys to `gh-pages` branch:
84+
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
85+
# The GH actions bot is used by default if you didn't specify the two fields.
86+
# You can swap them out with your own user credentials.
87+
user_name: github-actions[bot]
88+
user_email: 41898282+github-actions[bot]@users.noreply.github.com

0 commit comments

Comments
 (0)