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 suggestion: Option to include git hash in document #90

Open
KGHustad opened this issue Dec 23, 2016 · 0 comments
Open

Feature suggestion: Option to include git hash in document #90

KGHustad opened this issue Dec 23, 2016 · 0 comments
Assignees

Comments

@KGHustad
Copy link
Collaborator

Description of idea

Since I always work on DocOnce documents inside a git repository, I had the idea of adding an option to include the short version of the git hash (e. g. 87b8b7f), so that this information can be included if an error is found in the document. The author will then be able to check with his git repository (which may very well be private) and determine if the error has already been corrected, which versions were affected, etc.

Implementation

This could be implemented by DocOnce capturing the output of the following command and embedding the hash somewhere in the document.

$ git rev-parse --short HEAD
87b8b7f

Aesthetical considerations

It seems logical to me to place the hash together with the date, but I don't that looks good. A more subtle placement would be in the footer.

@KGHustad KGHustad self-assigned this Dec 23, 2016
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

1 participant