Skip to content

Build docs on GitHub instead of buildbot #3417

Open
@MattSturgeon

Description

@MattSturgeon

Currently we configure buildbot to build everything in our packages flake output on all systems. For the docs, this means x86_64-linux and aarch64-linux.

We don't really care that much if the docs can build on aarch64, so this is a waste of resources. Further, buildbot often struggles building docs on this platform; it is often the longest running build by far.

Since #3410, we are able to configure what buildbot builds explicitly without affecting nix flake check. I'd propose we set up a GitHub Actions workflow to build docs on pull_request or pull_request_target events and remove docs from buildbot.

Eventually, this workflow could also publish the PR's docs somewhere for easy viewing, however that should be out of scope for the initial PR. This would likely mean opening a dedicated "nixvim PR docs" repo for hosting another github-pages instance, or using an alternative to github pages.

TODO:

  • Remove docs packages from buildbot
  • Build docs website on github
  • Build other docs packages on github
  • Publish docs websites for PRs

Metadata

Metadata

Assignees

No one assigned

    Labels

    CI/CDRelated to CI or CD, i.e. GitHub Actions or BuildbotdocumentationImprovements or additions to documentation

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions