Skip to content

Auto-errata #6

@nstephenh

Description

@nstephenh

Auto-errata script and file format.
JSON file with names of things to update

Consider adding last known hash of entry to update

Want an array id changes with target to update and line to do so. Group by page of publication?

Goals of the auto-errata format:

  • Allow changes to be applied, and if a changed is removed from a future errata document, easily remove those changes.
    • Why can't you just do this with a git diff?
      • Because it's hard to tell what's a small data change and what's a conscious errata choice.

Limitations:

  • Not useful when you don't have a base version to compare to.

Specification Draft:

{
  "Document Name": {
    "version": "number",
    "bs_pub_id": "UUID",
    "pages": [
      {
        "page": "number",
        "change list": [
          {
            "Change specification": "<how the change happens somehow>",
            "affected nodes": [
              {
                "ID": "BS ID array, possibly auto-populated?"
              }
            ]
          }
        ]
      }
    ]
  }
}
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions