-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(README): update logo, def., usage, deps. info
Update `README.md` to add `latex-ci-template` logo, along with the repository definition, `how-to-use` steps, and dependency information. Basic project hierarchy is also discussed in addition to necessary steps to alter the hierarchy.
- Loading branch information
Showing
2 changed files
with
161 additions
and
3 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,39 @@ | ||
 | ||
|
||
<p align="center"> | ||
<a href="https://github.com/tunakasif/latex-ci-template/actions/workflows/release.yml"><img src="https://github.com/tunakasif/latex-ci-template/actions/workflows/release.yml/badge.svg" alt="Build status"/></a> | ||
<a href="https://github.com/tunakasif/latex-ci-template/actions/workflows/release.yml"><img alt="Build status" src="https://github.com/tunakasif/latex-ci-template/actions/workflows/release.yml/badge.svg"/></a> | ||
<a href="https://github.com/tunakasif/latex-ci-template/blob/main/LICENSE"><img alt="GitHub license" src="https://img.shields.io/github/license/tunakasif/latex-ci-template"></a> | ||
</p> | ||
|
||
# latex-ci-template | ||
# LaTeX-CI Template | ||
|
||
Template for writing CI enabled LaTeX documents. State of the LaTeX project is saved along with the current state's PDF output as release assets, according to the version number provided with a [git-tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging). | ||
|
||
## Usage | ||
|
||
Make changes to the LaTeX documents, and provide [git-tags](https://git-scm.com/book/en/v2/Git-Basics-Tagging) to the commits where you see fit, with annotations regarding the version as in the form of `v*` (e.g. v1.0.2). A PDF file will automatically be generated from the tags. In the wake of PDF generation, it will be used as an additional asset for the automatic release based on the provided tag. This template is written in a self-evident manner, hence for demonstration, checkout the [Releases](https://github.com/tunakasif/latex-ci-template/releases) page. | ||
|
||
## Dependencies for GitHub Actions | ||
|
||
Automation of LaTeX project build and tag-based releases is achieved with [GitHub Actions](https://github.com/features/actions). The workflow configuration is achieved with [`release.yml`](./.github/workflows/release.yml) file. The workflow dependencies are listed as follows: | ||
|
||
- [actions/checkout@v2](https://github.com/actions/checkout) | ||
- [xu-cheng/latex-action@v2](https://github.com/xu-cheng/latex-action) | ||
- [softprops/action-gh-release@v1](https://github.com/softprops/action-gh-release) | ||
|
||
## LaTeX Document Hierarchy | ||
|
||
The sample LaTeX document hierarchy is in the form below. It is a minimal demonstration of multi-file LaTeX project with images and bibliography. | ||
|
||
```stdout | ||
. | ||
├── bibliography.bib | ||
├── images | ||
│ └── space.jpg | ||
├── main.tex | ||
├── my_table.tex | ||
``` | ||
|
||
As expected, building process depends on the document hierarchy. This template is designed for the base case provided in [xu-cheng/latex-action@v2](https://github.com/xu-cheng/latex-action) such that we have a single `root_file: main.tex`, and we are compiling with default settings of [xu-cheng/latex-action@v2](https://github.com/xu-cheng/latex-action). The provided hierarchy can be changed easily, however [`release.yml`](./.github/workflows/release.yml) needs to be changed, accordingly. Since [xu-cheng/latex-action@v2](https://github.com/xu-cheng/latex-action) provides a rich documentation, this aspect should not be problematic. | ||
|
||
Template for writing CI enabled LaTeX documents. | ||
Finally, the [softprops/action-gh-release@v1](https://github.com/softprops/action-gh-release) action creates a release based on the provided tag, and adds the generated `main.pdf` from workspace directory to the assets of release. If a hierarchy change is on the table, then the release aspect of [`release.yml`](./.github/workflows/release.yml) needs to be altered, accordingly. |