https://github.com/bobbyiliev/ibis-build-action
GitHub Action to run ibis builds on merge
https://github.com/bobbyiliev/ibis-build-action
Last synced: 7 months ago
JSON representation
GitHub Action to run ibis builds on merge
- Host: GitHub
- URL: https://github.com/bobbyiliev/ibis-build-action
- Owner: bobbyiliev
- License: mit
- Created: 2021-10-28T09:26:19.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-11-17T14:18:12.000Z (almost 4 years ago)
- Last Synced: 2025-03-05T13:22:29.148Z (7 months ago)
- Language: HTML
- Homepage:
- Size: 1.7 MB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ibis-build-action
A GitHub Action to automatically run ibis builds on merge to `main`.
---
### Ibis
[Ibis](https://github.com/themsaid/ibis) is a PHP tool that lets you write eBooks in Markdown.
---
### Usage
In order to automatically build your Ibis PDF files, create a directory called `.github/workflows/` and add a fill called `ibis.yml` with the following content:
```yaml
name: Ibis eBook Generation
on:
push:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@main
with:
fetch-depth: '0'
- name: Build Ibis Export Files
uses: bobbyiliev/ibis-build-action@main
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
IBIS_PATH: './'
IBIS_BRANCH: 'main'
EMAIL: 'bobby@bobbyiliev.com'
COMMIT_MESSAGE: 'Updated Ibis Exorted Files'
```
## Environment Variables
* `GITHUB_TOKEN`: Required for permission to tag the repo. You can leave it as it is.
* `IBIS_PATH`: The path to the Ibis init folder. By default it is `./` but if you have a custom location, make sure to update it
* `IBIS_BRANCH`: The Branch that the Ibis exported files will be commited and pushed to. Default is `main`.
* `EMAIL`: The email address that the commit will be associated with.
* `COMMIT_MESSAGE`: The commit message.
## Workflow
* Add this action to your repository
* Commit some changes
* Either push to `main` or open a PR
* On push (or merge), the action will:
* Clone the repository
* Run the `ibis build` commands including the sample builds
* Stage and commit the new exported eBook files to the specified branch
* Pushes tag to GitHub
## Ebook Projects using ibis-build-action
* [Introduction to Docker](https://github.com/bobbyiliev/introduction-to-docker-ebook)
* [Introduction to Git and GitHub](https://github.com/bobbyiliev/introduction-to-git-and-github-ebook)
* [Introduction to Bash Scripting](https://github.com/bobbyiliev/introduction-to-bash-scripting)
* [Introduction to SQL](https://github.com/bobbyiliev/introduction-to-sql)
* [Laravel tips and tricks](https://github.com/bobbyiliev/laravel-tips-and-tricks-ebook)