UKHomeOffice / engineering-guidance-and-standards

Engineering Guidance and Standards for the Home Office
https://engineering.homeoffice.gov.uk
MIT License
14 stars 2 forks source link

[FEATURE] explicit version or machine-readable date for standard to allow referencing from other places #322

Open GraemeSutherlandHO opened 8 months ago

GraemeSutherlandHO commented 8 months ago

What is the feature or enhancement you are suggesting? Add a version or date to a standard that can reference a particular version of it.

What would be the benefit of doing this? When referencing a standard (or conforming to it), what happens if it is revised. This means that somebody could have been compliant and is then not. Arguments will follow. Think we need to be able to refer to a standard's explicit version externally (a hash, a version or tag, that is exposed). Also need to be able to retrieve older versions when needed to refer.

Additional information See also https://github.com/UKHomeOffice/engineering-guidance-and-standards/issues/315 which would require ability to reference a particular version.

Please confirm the below

edhamiltonHO commented 7 months ago

Initial suggestion for an MVP is to In layout for a standard Display a list of previous iterations of that standard (linked to commit hash for that md file) Potentially also include a link to the full history in Github for that md file

jeff-horton-ho-sas commented 5 months ago

To add a permalink to the current snapshot in GH we need the commit SHA when building the static site. To pass this in to the docker build we need to modify the shared SAS github actions as follows: