📈
ucore-analysis
  • Introduction
  • lab1
    • boot
      • bootasm
      • bootmain
    • kern
      • debug
        • kmonitor
        • panic
      • init
        • init
      • libs
        • readline
      • mm
        • pmm
      • trap
        • trap
        • trapentry
        • vectors
    • libs
    • tools
  • lab解析
    • lab1
      • 练习1
      • 练习2
      • 练习3
      • 练习4
      • 练习6
      • 扩展练习
      • Piazza优质问题/笔记收集
    • lab2
      • 练习1
      • 练习2
      • 练习3
    • lab3
    • lab4
    • lab5
    • lab6
    • lab7
    • lab8
  • uCore代码
    • boot
      • asm.h
      • bootasm.S
      • bootmain.c
      • (lab1) bootasm.S
    • kern
      • debug
        • assert.h
        • kdebug.c
        • kdebug.h
        • kmonitor.c
        • kmonitor.h
        • panic.c
        • stab.h
        • (lab1) kdebug.c
      • driver
        • clock.c
        • clock.h
        • console.c
        • console.h
        • ide.c
        • ide.h
        • intr.c
        • intr.h
        • kbdreg.h
        • picirq.c
        • picirq.h
      • fs
        • devs
          • dev.c
          • dev_disk0.c
          • dev.h
          • dev_stdin.c
          • dev_stdout.c
        • sfs
          • bitmap.c
          • bitmap.h
          • sfs.c
          • sfs_fs.c
          • sfs.h
          • sfs_inode.c
          • sfs_io.c
          • sfs_lock.c
        • swap
          • swapfs.c
          • swapfs.h
        • vfs
          • inode.c
          • inode.h
          • README.md
          • vfs.c
          • vfsdev.c
          • vfsfile.c
          • vfs.h
          • vfslookup.c
          • vfspath.c
        • file.c
        • file.h
        • fs.c
        • fs.h
        • iobuf.c
        • iobuf.h
        • sysfile.c
        • sysfile.h
      • init
        • entry.S
        • init.c
        • (lab1) init.c
      • libs
        • readline.c
        • stdio.c
        • string.c
      • mm
        • default_pmm.c
        • default_pmm.h
        • kmalloc.c
        • kmalloc.h
        • memlayout.h
        • mmu.h
        • pmm.c
        • pmm.h
        • swap.c
        • swap_fifo.c
        • swap_fifo.h
        • swap.h
        • vmm.c
        • vmm.h
        • (lab2) pmm.c
        • (lab3) vmm.c
      • process
        • entry.S
        • proc.c
        • proc.h
        • switch.S
        • (lab4) proc.c
        • (lab5) proc.c
      • schedule
        • default_sched.c
        • default_sched.h
        • default_sched_stride.c
        • sched.c
        • sched.h
      • sync
        • check_sync.c
        • monitor.c
        • monitor.h
        • sem.c
        • sem.h
        • sync.h
        • wait.c
        • wait.h
      • syscall
        • syscall.c
        • syscall.h
      • trap
        • trap.c
        • trapentry.S
        • trap.h
        • vectors.S
        • (lab1) trap.c
    • libs
      • atomic.h
      • defs.h
      • dirent.h
      • elf.h
      • error.h
      • hash.c
      • list.h
      • printfmt.c
      • rand.c
      • skew_heap.h
      • stat.h
      • stdarg.h
      • stdio.h
      • stdlib.h
      • string.c
      • string.h
      • unistd.h
      • x86.h
    • tools
      • boot.ld
      • function.mk
      • gdbinit
      • grade.sh
      • kernel.ld
      • mksfs.c
      • sign.c
      • user.ld
      • vector.c
    • user
      • libs
        • dir.c
        • dir.h
        • file.c
        • file.h
        • initcode.S
        • lock.h
        • panic.c
        • stdio.c
        • syscall.c
        • syscall.h
        • ulib.c
        • ulib.h
        • umain.c
      • badarg.c
      • badsegment.c
      • divzero.c
      • exit.c
      • faultread.c
      • faultreadkernel.c
      • forktest.c
      • forktree.c
      • hello.c
      • ls.c
      • matrix.c
      • pgdir.c
      • priority.c
      • sfs_filetest1.c
      • sh.c
      • sleep.c
      • sleepkill.c
      • softint.c
      • spin.c
      • testbss.c
      • waitkill.c
      • yield.c
    • Makefile
    • (lab1) Makefile
  • 附录：工具使用
    • 如何编辑该文档
    • 讨论区的维护方法
    • 使用Travis CI自动化更新gitbook
Powered by GitBook
On this page
  • 为什么要使用 CI
  • 配置方法
  • 目标与实现方法
  • 使用 CI 可能带来什么副作用
  • 其他问题
  • 后续维护者可以考虑的改进方向

Was this helpful?

  1. 附录：工具使用

使用Travis CI自动化更新gitbook

Previous讨论区的维护方法

Last updated 5 years ago

Was this helpful?

本方法是基于 进行的改进，所以在进行任何操作之前请先确保你阅读过这篇文档，并且对 CI 带来的影响有一定了解。

为什么要使用 CI

传统的方法需要维护者使用 gitbook 工具进行手动更新，这样效率比较低。使用 CI 后，本地不再需要依赖，一切交给 CI。

配置方法

需要维护者注册开启 Travis-CI，并添加 Personal access token 以便在 CI 的虚拟环境中能有权限访问 github。

首先需要注册并开启 Travis

  1. 用你的 GitHub 账号登录 Travis-CI，确认接受访问 GitHub 的权限。

  2. 登录之后，Travis-CI 就会同步你 GitHub 账号的仓库。然后打开个人页面并给你想要构建的项目启用 Travis-CI。

然后需要设置一个 Personal Access Token

  1. 在 Github 中，Settings / Developer settings / Personal access tokens 页面下创建一个新的 Token

  2. 注意一定要勾选 repo 的作用权限，否则 CI 将无法正常工作

  3. 复制你的 token，在 travis-ci 的网站中该项目下选择 More options / settings

  4. 在下方 Environment Varaibles 中添加一个环境变量

    1. NAME 一项输入 GITHUB_TOKEN

    2. VALUE 一项输入你刚刚生成的 Token

  5. 完成配置

再次提交后，即可看到自动构建开始。

目标与实现方法

为了尽量不修改项目结构，因此这个 .Travis.yml 文件的首要目标是只在项目中添加这一个文件，就可以完成需求的功能。

因此在 .travis.yml 中，主要做的事情就是编译后提交至原 repo 的 master 分支。

使用 CI 可能带来什么副作用

  • 在每次提交后，文档都会自动编译更新，无法进行选择更新

    • 可以增加规则，但是这样又会增加维护者的心智负担

  • 自动编译更新的文档会作为新的 Commit，但是这也造成下次提交之前需要手动 git pull 以更新本地进度。

其他问题

后续维护者可以考虑的改进方向

在改进过程中发现一些小问题。不影响使用，但仍有改进空间。

  • 解决编辑者在下次提交之前需要先拉取 CI 自动生成的 Commit

    • （使用两个 Repo）

  • 解决现在 node_modules 也被 git 管理的问题

gitbook文档维护