PR: Contrib Build instructions for Safari Extensions and added make's phny-pipeline for MacOS #43
Conversation
This file contains 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
unmasked prj build files.
The top-level README is extended with CONTRIB describing Safari build pipeline
and conversion and the docs/safari.md contains documentation on how to
build Shiori extension for Safari, and promptly install/setup the Safari
for such experience.
Also added images to contain safari(md)
The biggest change is in Makefile, and this change incldues:
* Setting up default Bundle Identifier for the App (required by the
MacOS)
* Otherwise use the provided (argumented) ENV string via CLI
* Added new phony handler 'run-safari' which uses Apple conversion
toolkit to convert and prepare XCode project dir
* Outputs completion message and report back to user
Additionally, I've added a 'clean' handler that will cleanup the Safari
build pipeline directives and leftovers.
Signed-off by: H. Duraki <h@durakiconsulting.com>
fmartingr
requested changes
Jun 11, 2023
There was a problem hiding this comment.
Hey @duraki, thanks a lot for this contribution! I've only suggested the changes on the BUNDLE_ID on the documentation and the Makefile, as it would be confusing to have another reference in Shiori's documentation and the markdown links that I think should be relative to the file.
Apart from that this seems very detailed and good to go. :)
(Please re-request my review once I can check this again!)
| @@ -1,3 +1,9 @@ | |||
| SHIORI_BUNDLE_IDENTIFIER ?= "com.durakiconsulting.shiori" | |||
There was a problem hiding this comment.
Suggested change
| SHIORI_BUNDLE_IDENTIFIER ?= "com.durakiconsulting.shiori" | |
| SHIORI_BUNDLE_IDENTIFIER ?= "com.go-shiori.shiori" |
| $ cat Makefile | grep Safari -C 2 | ||
| # ... | ||
| # run-safari: | ||
| # xcrun safari-web-extension-converter . --project-location xcprj/ --app-name Shiori --bundle-identifier com.durakiconsulting.shiori --macos-only --force |
There was a problem hiding this comment.
Suggested change
| # xcrun safari-web-extension-converter . --project-location xcprj/ --app-name Shiori --bundle-identifier com.durakiconsulting.shiori --macos-only --force | |
| # xcrun safari-web-extension-converter . --project-location xcprj/ --app-name Shiori --bundle-identifier com.go-shiori.shiori --macos-only --force |
| # xcrun safari-web-extension-converter . --project-location xcprj/ --app-name Shiori --bundle-identifier com.durakiconsulting.shiori --macos-only --force | ||
| ``` | ||
|
|
||
| You need to set `ENV` variable `SHIORI_BUNDLE_IDENTIFIER` to your bundle identifier, using classical bundle identifier naming convention, such is `ext.yourcompanyname.shiori`. This identifier can be passed during make (defaults to `'com.durakiconsulting.shiori'`). |
There was a problem hiding this comment.
Suggested change
| You need to set `ENV` variable `SHIORI_BUNDLE_IDENTIFIER` to your bundle identifier, using classical bundle identifier naming convention, such is `ext.yourcompanyname.shiori`. This identifier can be passed during make (defaults to `'com.durakiconsulting.shiori'`). | |
| You need to set `ENV` variable `SHIORI_BUNDLE_IDENTIFIER` to your bundle identifier, using classical bundle identifier naming convention, such is `ext.yourcompanyname.shiori`. This identifier can be passed during make (defaults to `'com.go-shiori.shiori'`). |
| Once in XCode, run `Shift + Cmd + R` (`Product => Build For => Running` via Menu) to build release version and generate application product. | ||
| Once the above finished, click `Product => Show Build folder in Finder` and enter `Product/Debug/` directory from inside the Finder and you should see `Shiori.app`. | ||
|
|
||
|  |
There was a problem hiding this comment.
Shouldn't this be?
Suggested change
|  | |
|  |
|
|
||
| Open the built Shiori application and follow the screen instructions. | ||
|
|
||
|  |
There was a problem hiding this comment.
Shouldn't this be?
Suggested change
|  | |
|  |
|
|
||
| Once enabled, you can click `Settings` button for Shiori, or right-click on Shiori toolbar icon, and click `Manage Extension`. This will open Shiori Session settings where you will enter your server URL and username and password combo. | ||
|
|
||
|  |
There was a problem hiding this comment.
Shouldn't this be?
Suggested change
|  | |
|  |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 PR describes build process for MacOS Mojave, specifically the Safari, with a small changes occurring on Makefile. The placeholder for
BUNDLE_IDcan be switched, as this is a forked PR, it sat as a notation.Let me know what you think and if any changes are necessary 🙌