mirror of
https://github.com/hendricius/the-sourdough-framework
synced 2025-11-09 04:31:11 -06:00
🤡 Add "make bake" command (#97)
I feel like since this is bread related, release should be renamed to "bake". So `make bake` will bake you the final book versions.
This commit is contained in:
committed by
GitHub
parent
c2d5e88377
commit
6c8839da87
6
.github/workflows/main.yml
vendored
6
.github/workflows/main.yml
vendored
@@ -9,7 +9,7 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- name: Set up git repository
|
- name: Set up git repository
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v3
|
||||||
- name: Build the book
|
- name: Bake the book
|
||||||
uses: xu-cheng/texlive-action/full@v1
|
uses: xu-cheng/texlive-action/full@v1
|
||||||
with:
|
with:
|
||||||
run: |
|
run: |
|
||||||
@@ -18,8 +18,8 @@ jobs:
|
|||||||
tar xzf kindlegen_linux_2.6_i386_v2_9.tar.gz
|
tar xzf kindlegen_linux_2.6_i386_v2_9.tar.gz
|
||||||
mv kindlegen /usr/bin
|
mv kindlegen /usr/bin
|
||||||
cd book
|
cd book
|
||||||
make release
|
make bake
|
||||||
- name: Release book on S3
|
- name: Release baked book to S3
|
||||||
uses: shallwefootball/s3-upload-action@master
|
uses: shallwefootball/s3-upload-action@master
|
||||||
with:
|
with:
|
||||||
aws_key_id: ${{ secrets.AWS_KEY_ID }}
|
aws_key_id: ${{ secrets.AWS_KEY_ID }}
|
||||||
|
|||||||
4
.github/workflows/validate.yml
vendored
4
.github/workflows/validate.yml
vendored
@@ -13,7 +13,7 @@ jobs:
|
|||||||
apk add make
|
apk add make
|
||||||
cd book
|
cd book
|
||||||
make build_pdf
|
make build_pdf
|
||||||
- name: Test building release versions
|
- name: Test baking the release versions
|
||||||
uses: xu-cheng/texlive-action/full@v1
|
uses: xu-cheng/texlive-action/full@v1
|
||||||
with:
|
with:
|
||||||
run: |
|
run: |
|
||||||
@@ -22,4 +22,4 @@ jobs:
|
|||||||
tar xzf kindlegen_linux_2.6_i386_v2_9.tar.gz
|
tar xzf kindlegen_linux_2.6_i386_v2_9.tar.gz
|
||||||
mv kindlegen /usr/bin
|
mv kindlegen /usr/bin
|
||||||
cd book
|
cd book
|
||||||
make release
|
make bake
|
||||||
|
|||||||
12
README.md
12
README.md
@@ -24,7 +24,7 @@ as possible are provided.
|
|||||||

|

|
||||||
|
|
||||||
|
|
||||||
## Building the book (Docker)
|
## 🍞 Baking the book (Docker)
|
||||||
|
|
||||||
```console
|
```console
|
||||||
make
|
make
|
||||||
@@ -32,15 +32,15 @@ make
|
|||||||
|
|
||||||
Then you can check out the file `book/book.pdf`
|
Then you can check out the file `book/book.pdf`
|
||||||
|
|
||||||
If you want to build the eBook versions (.epub, .mobi, .azw3) run:
|
If you want to 🍞 bake all the versions including ebook formats (.pdf, .epub, .mobi, .azw3) run:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
make release
|
make bake
|
||||||
```
|
```
|
||||||
|
|
||||||
You can check the files in the folder `book/release/`
|
You can check the files in the folder `book/release/`
|
||||||
|
|
||||||
## Building the book locally (LaTeX)
|
## 🍞 Baking the book locally (LaTeX)
|
||||||
|
|
||||||
Make sure you have `biber` installed. Refer to your system's installation
|
Make sure you have `biber` installed. Refer to your system's installation
|
||||||
instructions for LaTeX.
|
instructions for LaTeX.
|
||||||
@@ -50,11 +50,11 @@ cd book/
|
|||||||
make
|
make
|
||||||
```
|
```
|
||||||
|
|
||||||
If you want to build the eBook versions (.epub, .mobi, .azw3) run:
|
If you want to 🍞 bake all the versions including ebook formats (.pdf, .epub, .mobi, .azw3) run:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
cd book/
|
cd book/
|
||||||
make release
|
make bake
|
||||||
```
|
```
|
||||||
|
|
||||||
You can check the files in the folder `book/release/`
|
You can check the files in the folder `book/release/`
|
||||||
|
|||||||
@@ -78,8 +78,8 @@ release_default: clean build_pdf make_release_dir build_ebook
|
|||||||
cp book-epub/book.epub release/TheBreadCode-The-Sourdough-Framework.epub
|
cp book-epub/book.epub release/TheBreadCode-The-Sourdough-Framework.epub
|
||||||
cp book-azw3/book.azw3 release/TheBreadCode-The-Sourdough-Framework.azw3
|
cp book-azw3/book.azw3 release/TheBreadCode-The-Sourdough-Framework.azw3
|
||||||
|
|
||||||
.PHONY: release_default
|
.PHONY: bake
|
||||||
release: release_default release_sans_serif
|
bake: release_default release_sans_serif
|
||||||
|
|
||||||
.PHONY: make_release_dir
|
.PHONY: make_release_dir
|
||||||
make_release_dir:
|
make_release_dir:
|
||||||
|
|||||||
6
makefile
6
makefile
@@ -2,9 +2,9 @@
|
|||||||
build_book: build_docker_image
|
build_book: build_docker_image
|
||||||
docker run -it -v .:/opt/repo the-sourdough-framework /bin/bash -c "cd /opt/repo/book && make build_pdf"
|
docker run -it -v .:/opt/repo the-sourdough-framework /bin/bash -c "cd /opt/repo/book && make build_pdf"
|
||||||
|
|
||||||
.PHONY: release
|
.PHONY: bake
|
||||||
release: build_docker_image
|
bake: build_docker_image
|
||||||
docker run -it -v .:/opt/repo the-sourdough-framework /bin/bash -c "cd /opt/repo/book && make release"
|
docker run -it -v .:/opt/repo the-sourdough-framework /bin/bash -c "cd /opt/repo/book && make bake"
|
||||||
|
|
||||||
.PHONY: build_docker_image
|
.PHONY: build_docker_image
|
||||||
build_docker_image:
|
build_docker_image:
|
||||||
|
|||||||
Reference in New Issue
Block a user