Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Book Progression and validation workflow documentation #1471

Open
rupsis opened this issue Mar 28, 2024 · 1 comment
Open

Add Book Progression and validation workflow documentation #1471

rupsis opened this issue Mar 28, 2024 · 1 comment
Assignees
Milestone

Comments

@rupsis
Copy link
Contributor

rupsis commented Mar 28, 2024

Before the release of any new publication of the Book(s), a run through is needed to ensure the progress of the code compiles, produces the correct results, and the text makes sense.

This is a rather involved process, and there is some "tribal knowledge" around progression procedures.

We should document these procedures in a common location.

@hollasch hollasch self-assigned this Mar 28, 2024
@hollasch hollasch added this to the Backlog milestone Mar 28, 2024
@hollasch
Copy link
Collaborator

hollasch commented Apr 4, 2024

  • Set up initial state
  • Commit at each listing, unless it's in an uncompilable state
  • In a separate worktree, make book and image fixes
  • Validate rendered images
  • Validate final state against source

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

No branches or pull requests

2 participants