README.ja.md

platex-action

---

platex-actionはTeXファイルをコンパイルしてPDFを作成するGitHub Actionです。

Description

platex-actionは、GitHub上であなたのTeXファイルをコンパイルし、main.pdfを作成します。
コンパイルしたいTeXファイルの名前はLATEX_FILE_NAMEで指定します。

注意点として、platex-actionはTeXファイルのコンパイルならびにPDFの作成のみを行います。
GitHubの公式が作成しているRelease Actionを併用することでコンパイルしたPDFを簡単にReleaseにアップロードできます。

Usage

あなたのTeXファイルが置かれているリポジトリをXと呼ぶことにします。

Xのリポジトリにおいて、.github/workflowsディレクトリにmain.ymlファイルを作成します。
ただし、main.ymlという名前である必要はなくtex.ymlなどでも構いません。

作成したYAMLファイルに以下のように記述します。
LATEX_FILE_NAMEにはXのリポジトリにあるTeXファイルの名前を指定してください。

# The Example of Compiling LaTeX File
# In your latex repository, make .github/workflows/main.yml like below.
# You only have to change `LATEX_FILE_NAME` as your tex file.

on:
  push:
    tags:
      - "v*"

jobs:
  test_job:
    runs-on: ubuntu-latest
    name: Example of compiling pdf
    steps:
      # make pdf
      # LATEX_FILE_NAME -> main.pdf generated
      - name: Set up Git repository
        uses: actions/checkout@v2
      - name: Compile Tex File
        id: compile_tex_file
        uses: tsukuba-mas/platex-action@main
        with:
          LATEX_FILE_NAME: "main.tex"
      # Create Release
      - name: Create Release
        id: create_release
        uses: actions/create-release@v1
        env:
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
        with:
          tag_name: ${{github.ref}}
          release_name: Release ${{ github.ref }}
          body: |
            Compiled PDF ${{github.ref}}
          draft: false
          prerelease: false
      # Upload Asset main.pdf
      - name: Upload Release Asset
        id: upload_release_asset
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ steps.create_release.outputs.upload_url }}
          asset_path: ./main.pdf
          asset_name: main.pdf
          asset_content_type: application/pdf

secrets.GITHUB_TOKENやgithub.refなどは、GitHub側で自動設定されるため、ユーザが設定を行う必要はありません。
そのため、LATEX_FILE_NAMEのみの変更で良いはずです。

あとはGitHubにタグvX.X.Xをプッシュすると自動でGitHub ReleasesにPDFが作成されます。

Example

tsukuba-mas/how-to-revise

Licence

MIT

Author

Tsukuba Multi Agent System Research Lab