From 6c8839da8729c7542109e932505a20da084e1c2a Mon Sep 17 00:00:00 2001 From: Hendrik Kleinwaechter Date: Sun, 21 May 2023 20:19:56 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=A4=A1=20Add=20"make=20bake"=20command=20?= =?UTF-8?q?(#97)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit I feel like since this is bread related, release should be renamed to "bake". So `make bake` will bake you the final book versions. --- .github/workflows/main.yml | 6 +++--- .github/workflows/validate.yml | 4 ++-- README.md | 12 ++++++------ book/makefile | 4 ++-- makefile | 6 +++--- 5 files changed, 16 insertions(+), 16 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index d8360bf..b0717e6 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -9,7 +9,7 @@ jobs: steps: - name: Set up git repository uses: actions/checkout@v3 - - name: Build the book + - name: Bake the book uses: xu-cheng/texlive-action/full@v1 with: run: | @@ -18,8 +18,8 @@ jobs: tar xzf kindlegen_linux_2.6_i386_v2_9.tar.gz mv kindlegen /usr/bin cd book - make release - - name: Release book on S3 + make bake + - name: Release baked book to S3 uses: shallwefootball/s3-upload-action@master with: aws_key_id: ${{ secrets.AWS_KEY_ID }} diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml index 961f399..9a39146 100644 --- a/.github/workflows/validate.yml +++ b/.github/workflows/validate.yml @@ -13,7 +13,7 @@ jobs: apk add make cd book make build_pdf - - name: Test building release versions + - name: Test baking the release versions uses: xu-cheng/texlive-action/full@v1 with: run: | @@ -22,4 +22,4 @@ jobs: tar xzf kindlegen_linux_2.6_i386_v2_9.tar.gz mv kindlegen /usr/bin cd book - make release + make bake diff --git a/README.md b/README.md index ec8add3..c2c11aa 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ as possible are provided. ![A whole wheat sourdough bread](./book/images/whole-wheat-crumb.jpg) -## Building the book (Docker) +## 🍞 Baking the book (Docker) ```console make @@ -32,15 +32,15 @@ make 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 -make release +make bake ``` 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 instructions for LaTeX. @@ -50,11 +50,11 @@ cd book/ 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 cd book/ -make release +make bake ``` You can check the files in the folder `book/release/` diff --git a/book/makefile b/book/makefile index 0a0a107..e257e1a 100644 --- a/book/makefile +++ b/book/makefile @@ -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-azw3/book.azw3 release/TheBreadCode-The-Sourdough-Framework.azw3 -.PHONY: release_default -release: release_default release_sans_serif +.PHONY: bake +bake: release_default release_sans_serif .PHONY: make_release_dir make_release_dir: diff --git a/makefile b/makefile index d9a03f2..bd9349f 100644 --- a/makefile +++ b/makefile @@ -2,9 +2,9 @@ build_book: build_docker_image docker run -it -v .:/opt/repo the-sourdough-framework /bin/bash -c "cd /opt/repo/book && make build_pdf" -.PHONY: release -release: build_docker_image - docker run -it -v .:/opt/repo the-sourdough-framework /bin/bash -c "cd /opt/repo/book && make release" +.PHONY: bake +bake: build_docker_image + docker run -it -v .:/opt/repo the-sourdough-framework /bin/bash -c "cd /opt/repo/book && make bake" .PHONY: build_docker_image build_docker_image: