Let someone else take care of keeping up to date tangled/woven versions of your Org files for public consumption.
- name: Export org files
uses: tecosaur/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}parameter(default)- description
- boolean
- can be
true/falseoryes/no - list
- can be a single value, comma separated values (without quotes), or a python list as a string.
config(boolean or list:false)- Path to either an
init.elfile, or a repository url (i.e. ends with.git) for~/.emacs.d. This also recognises Doom configuration repositories (~/.config/doom). setup_file(boolean or list:false)- URL for a
#+setupfileto use in all Org files. eval(boolean or list:false)- Whether to evaluate code in Org files. Also accepts a list of globs specifying which Org files should be evaluated.
tangle(boolean or list:false)- Whether to run
org-tanglefor each Org file. Also accepts a list of globs specifying which Org files should be tangled. export(list:html)- Comma separated list of formats to export to.
files(list:**/*.org)- List of org file globs to act on.
github_token(string)- The
GITHUB_TOKENsecret. Required to push any result. branch(string: default branch)- The branch to push files to
force_orphan(boolean:false)- Force-push the created commit as the only commit on the branch.
keep_files(boolean or list:true)- Whether to include non-org-related files. Also accepts a list of globs.
commit_message(string:Knit: !#!)- Commit message to use.
!#!is replaced with the triggering commit hash. fragile(boolean:true)- Fail the action if any export/tangle steps fail.
In each of the examples below, a simple preamble like so is assumed.
name: "Export"
on: [push]
jobs:
export:
runs-on: ubuntu-latest
- name: Checkout
uses: actions/checkout@v2- name: Export Org files to GitHub Pages
uses: tecosaur/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
# add PDFs
# export: html, pdf- name: Tangle Org files
uses: tecosaur/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
tangle: yes