Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: docs

on:
# trigger deployment on every push to main branch
push:
branches: [main]
# trigger deployment manually
workflow_dispatch:

jobs:
docs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
with:
# fetch all commits to get last updated time or other git log info
fetch-depth: 0

- name: Setup Node.js
uses: actions/setup-node@v4
with:
# choose node.js version to use
node-version: 16

- name: Install deps
working-directory: ./docs
run: npm install

- name: Copy changelog
run: cp CHANGELOG.md docs/changelog.md

- name: Copy assets
run: |
mkdir -p docs/.vuepress/public
cp art/logo_mixed.gif docs/.vuepress/public/logo.gif
cp art/heart.svg docs/.vuepress/public/heart.svg
cp art/heart.png docs/.vuepress/public/heart.png

# run build script
- name: Build VuePress site
working-directory: ./docs
run: npx vuepress build

# please check out the docs of the workflow for more details
# @see https://github.com/crazy-max/ghaction-github-pages
- name: Deploy to GitHub Pages
uses: crazy-max/ghaction-github-pages@v4
with:
# deploy to gh-pages branch
target_branch: gh-pages
# deploy the default output dir of VuePress
build_dir: docs/.vuepress/dist
env:
# @see https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
1 change: 1 addition & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
module.exports = {
base: '/phpinsights/',
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can be removed for this repo if using a custom domain, but required for the demo or to host at <username.github.io>/phpinsights/

title: 'PHP Insights',
description: 'The perfect starting point to analyze the code quality of your PHP projects',
sidebar: true,
Expand Down