diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000..c5026274 --- /dev/null +++ b/.github/workflows/docs.yml @@ -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 }} diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 022261cc..5f96260e 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -1,4 +1,5 @@ module.exports = { + base: '/phpinsights/', title: 'PHP Insights', description: 'The perfect starting point to analyze the code quality of your PHP projects', sidebar: true,