Skip to content

Commit

Permalink
docs: add CI job to build static page
Browse files Browse the repository at this point in the history
  • Loading branch information
piotrmacha committed May 23, 2024
1 parent c508235 commit 11f6179
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 2 deletions.
34 changes: 34 additions & 0 deletions .github/workflows/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: mkdocs
on:
push:
branches:
- feature/docs
- main
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- name: Setup token for branch rules bypass
uses: webfactory/ssh-agent@v0.9.0
if: ${{ inputs.push-version-commit == true }}
with:
ssh-private-key: ${{ secrets.NEKOBOCIK_SSH_KEY }}
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: mkdocs gh-deploy --force
7 changes: 5 additions & 2 deletions docs/docs/roadmap/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,12 @@

## Future Plans

!!! question "New features?"
We still may plan to implement some new features if they can provide value.

!!! danger "Complete Product Release (v1.0.0)"
Before we release version v1.0.0 and mark zBassMusic as a finished product, we need to:

* finish all the features in the backlog
* battle-test the system by having it working in multiple released Gothic mods
* fix all bugs and crashes that have a meaningful probability of causing Access Violation on players' games
* battle-test the system by having it work in multiple released Gothic mods
* fix all bugs and crashes that have a meaningful probability of causing Access Violations on players' games

0 comments on commit 11f6179

Please sign in to comment.