Skip to content

Improve (and Solidify) Site Building Procedure #14

Description

@eriq-augustine

Many of our tools/repos use the scripts/build_site.sh script to build their sites.

The basic procedure is as follows:

  • Make sure repo is clean.
  • Checkout Main
    • Gen Docs (label as "latest")
  • For each tag (past a certain point):
    • Checkout
    • Gen Docs
  • Checkout Main

Some issues with this procedure:

  • Does not work on dirty repo (which includes if you are updating the build_site.sh script itself).
  • Does not work on non-main branches.
  • Will fail if there is a mismatch between the currently installed dependencies and the checked out tag.
    • This limits how far back we can go, because they, for example, may be using an old edq-utils.

This last issue is particularly an issue.

I think we should have some new procedure that deals with all these issues.
Maybe something like:

  • Copy current repo/dir to temp dir.
  • Gen Docs (label as "latest")
  • For each tag (with some filtering pattern):
    • Clean Repo
    • Create new Venv and Install Deps
    • Gen Docs

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions