Add README, try to make workflow work
Some checks failed
/ jekyll (push) Failing after 16s

This commit is contained in:
Bill Niblock 2024-06-14 16:46:06 -04:00
parent 81ab50e565
commit 5e6112fb18
2 changed files with 50 additions and 8 deletions

View file

@ -11,20 +11,24 @@ jobs:
uses: actions/checkout@v4
with:
ref: pages
path: '_site'
path: _site
- name: Setup cache directory
run: mkdir .jekyll-cache
- name: Install dependencies
run: bundle install
- name: Build the site
run: jekyll build --trace
- name: Publish
- name: Check source status
run: |
git status
- name: Check site status
run: |
cd _site
touch .nojekyll
git config user.name "Scribe"
git config user.email "scribe@niblock.tech"
git add -A
git status
git commit -m "Automated Publish"
git push
# touch .nojekyll
# git config user.name "Scribe [bot]"
# git config user.email "scribe@niblock.tech"
# git add -A
# git status
# git commit -m "Automated Publish"
# git push

38
README.md Normal file
View file

@ -0,0 +1,38 @@
# TTRPG Compendium
Static, Jekyll-based site for all tabletop RPG-related stuff I write about.
### Adventures
Some of the adventures I've written up or am working on.
### Journals
Both character and campaign journals
### Tools
Stuff that helps with TTRPG play.
## Building
For just running locally, easiest is to use a container:
```
docker run --rm \
--volume="$PWD:/srv/jekyll:Z" \
--publish [::1]:4000:4000 \
jvconseil/jekyll-docker \
jekyll serve
```
For modifying and publishing newly generated content, the following process
works pretty well:
1. Remove the `_site` directory.
2. Clone the "pages" branch into `_site`:
`git clone -b pages ssh://git@forge.niblock.tech:8222/vagabond/ttrpg-compendium.git _site`
3. Run the container from above step. It will now build into `_site`, which is
linked to the "pages" branch.
4. When satisfied with changes, be sure to push both from `_site` and the base
repository to keep the source and the results up-to-date.