maint: add a comment to help point to a solution when docker build on macOS #88
Conversation
User Test ResultsTest specification and instructions User tests are not required |
| # | ||
| _builder_get_operating_system() { | ||
| declare -g BUILDER_OS | ||
| # Note: on macOS, bash version 4 or above is needed for `declare -g`. |
There was a problem hiding this comment.
I wonder instead of putting the comment here, if we add a note in the README.md file to mention/link to the Shared Dependencies in the main repo.
Did you have to use HomeBrew to upgrade Bash?
There was a problem hiding this comment.
I used HomeBrew. Linking to the docs would be better.
There was a problem hiding this comment.
Yes, as Darcy wrote, this is already documented at:
https://github.com/keymanapp/keyman/blob/2721c74a9188295320094da5237b8066a7387d08/docs/build/macos.md#L87
We could make this more visible in README.md for each of the sites.
I don't think we should add dependency comments into builder.inc.sh -- this is too buried to be useful.
Also, changes to builder.inc.sh need to be made in the keyman repo, because that's the primary version, but changes require builds on all platforms, and then ripple across to websites too, so best to avoid making changes unless really needed.
There was a problem hiding this comment.
I agree that this is not the best place for it. I'm glad I was able to found out the reason behind my error and this will be a note for me to remember. Since there's already a document for this, I'll go ahead and close this PR. I'm still unsure on what to add for the README file so I won't do that now.
3 participants
This PR is ready for reviews.
Test-bot: skip