Display git version & date to introduction section#551
Merged
Conversation
This is to learn which specific commit of the book is published on the official site: https://defmt.ferrous-systems.com/ * add mdbook preprocessor to replace the version placeholder string with the git version and date * add short section in the introduction to display version **Note** the `sed` command is written to be compatibly on OSX (the extra `.bak` command) and Unix systems, for some details check this SO discussion: https://stackoverflow.com/questions/4247068/sed-command-with-i-option-failing-on-mac-but-works-on-linux
Contributor
|
The deploy preview still shows the placeholder, did it not work? |
Author
|
Yes, it seems the |
Instead of find and replace the version via `sed`, the git version & date are added to an empty `version.md` file that is included in the introduction section of the book.
Author
|
The preview now displays used git hash and commit date. |
Contributor
|
cool! bors r+ |
Contributor
|
Build succeeded: |
Member
|
That's neat! 🎉 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This change is to know which specific commit of the book is published on the official site: https://defmt.ferrous-systems.com/
Note the
sedcommand is written to work on OSX (the extra.bakparameter) and Unix systems, for some details check this SO discussionReference: