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

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

Open
1 task done
GraemeSutherlandHO opened this issue Oct 27, 2023 · 3 comments
Assignees
Labels
enhancement New feature or request

Comments

@GraemeSutherlandHO
Copy link

GraemeSutherlandHO commented Oct 27, 2023

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 #315 which would require ability to reference a particular version.

Please confirm the below

  • I have checked through the issues on the repository and this has not already been suggested
@GraemeSutherlandHO GraemeSutherlandHO added the enhancement New feature or request label Oct 27, 2023
@GraemeSutherlandHO GraemeSutherlandHO changed the title [FEATURE] explicit version of [FEATURE] explicit version or machine-readable date for standard to allow referencing from other places Oct 27, 2023
@edhamiltonHO
Copy link
Contributor

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
Copy link
Contributor

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:

@jeff-horton-ho-sas
Copy link
Contributor

Paused pending switch to core-cloud which will remove the issue of building the SHA into the docker image.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
4 participants