Git-based page histories plugin does not work

[get1024]

The plug-in is configured according to the tutorial in the documentation, but does not work after deployment。

config.mts

docs.vitepress\theme\index.ts

and the result on my website is as:

Has anyone succeeded in following the documentation? Is there anything wrong with my configuration process? Ask for advice

[nekomeowww]

What kind of the static web page hosting service are you using?

• Cloudflare Pages?
• Netlify?
• GitHub Actions?

Git-based page histories require the full git logs in order to display the entire histories of the pages, and some of the native and CI/CD pipelines of services like Cloudflare Pages and Vercel doesn't include all the git histories (a.k.a. git log), and not even configurable.

• For Cloudflare Pages, you can switch to GitHub Actions based Cloudflare Pages deployment to achieve more flexible git log fetching abilities, more code examples are here https://github.com/nekomeowww/ollama-operator/blob/9501188cfcfffd6d2a2f5d6908807668bcb62be1/.github/workflows/production-docs-deployment.yaml in my another project uses @nolebase/vitepress-plugin-git-changelog.
• For Vercel, you can switch to GitHub Actions based Vercel deployment to achieve more flexible git log fetching abilities. But I never use Vercel, so you will have to find out how to use it to deploy through GitHub Actions on your own.
• For Netlify, you don't need to configure anything.
• For GitHub Actions, you need to specify fetch-depth as 0 as follows before building with pnpm run docs:build (or whatever you specified):

- uses: actions/checkout@v4
  with:
    # Number of commits to fetch. 0 indicates all history for all branches and tags.
    # Default: 1
    fetch-depth: 0

Please provide me with more details about whether you have git logs or not, what services and platforms you are using, versions of environments, etc. if none of these above scenario fits you in.

[nekomeowww]

I currently deploy through the github action, deploy.yml is the default configuration provided in the vitepress documentation

Can you see the git logs with development server (pnpm run docs:dev)

[get1024]

nope the content of my deploy.yml as follows:

# 构建 VitePress 站点并将其部署到 GitHub Pages 的示例工作流程
#
name: Deploy VitePress site to Pages

on:
  # 在针对 `main` 分支的推送上运行。如果你
  # 使用 `master` 分支作为默认分支，请将其更改为 `master`
  push:
    branches: [main]

  # 允许你从 Actions 选项卡手动运行此工作流程
  workflow_dispatch:

# 设置 GITHUB_TOKEN 的权限，以允许部署到 GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# 只允许同时进行一次部署，跳过正在运行和最新队列之间的运行队列
# 但是，不要取消正在进行的运行，因为我们希望允许这些生产部署完成
concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  # 构建工作
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0 # 如果未启用 lastUpdated，则不需要
      # - uses: pnpm/action-setup@v3 # 如果使用 pnpm，请取消注释
      # - uses: oven-sh/setup-bun@v1 # 如果使用 Bun，请取消注释
      - name: Setup Node
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: npm # 或 pnpm / yarn
      - name: Setup Pages
        uses: actions/configure-pages@v4
      - name: Install dependencies
        run: npm ci # 或 pnpm install / yarn install / bun install
      - name: Build with VitePress
        run: npm run docs:build # 或 pnpm docs:build / yarn docs:build / bun run docs:build
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/.vitepress/dist

  # 部署工作
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    needs: build
    runs-on: ubuntu-latest
    name: Deploy
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

whether run pnpm run docs:dev or submit it to the repository, none of my sites show git logs💔

[nekomeowww]

What is your directory structure? Are your pages live under a different path instead of the root directory? If so, you will need to use rewritePaths options to rewrite.

Could you please check with it?

[get1024]

My project directory structure is shown in the figure, and since I am not directly deployed at [username].github.io , I configured the base value in config.mts.

my repo: 'https://github.com/get1024/RyanJoy-s_Web', so the base:'/RyanJoy-s_Web/'.

Does this affect the use of the git log plugin?

[nekomeowww]

Yes.

PS: There is a new pending release includes #189 which introduce a feature to allow users to use GitChangelog plugin without the need to configure rewritePaths. It will be released soon in an hour. Could you please wait for me to release the next rc version and then try it out?

[get1024]

Of course! Thank you for your patience. Have a great day!

[nekomeowww]

Of course! Thank you for your patience. Have a great day!

Released.