{"id":16573372,"url":"https://github.com/tecosaur/org-knit-action","last_synced_at":"2025-03-21T12:31:22.360Z","repository":{"id":65161988,"uuid":"339177597","full_name":"tecosaur/org-knit-action","owner":"tecosaur","description":"Let someone else take care of keeping up to date tangled/woven versions of your Org files for public consumption.","archived":false,"fork":false,"pushed_at":"2022-10-08T15:42:18.000Z","size":55,"stargazers_count":31,"open_issues_count":2,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-18T01:11:30.717Z","etag":null,"topics":["github-actions","org-mode","publishing"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tecosaur.png","metadata":{"files":{"readme":"README.org","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-02-15T19:00:30.000Z","updated_at":"2025-03-04T21:52:50.000Z","dependencies_parsed_at":"2023-01-04T12:39:03.738Z","dependency_job_id":null,"html_url":"https://github.com/tecosaur/org-knit-action","commit_stats":{"total_commits":9,"total_committers":2,"mean_commits":4.5,"dds":"0.33333333333333337","last_synced_commit":"c4856068cfe7f456b67028051293463785ec20bc"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tecosaur%2Forg-knit-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tecosaur%2Forg-knit-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tecosaur%2Forg-knit-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tecosaur%2Forg-knit-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tecosaur","download_url":"https://codeload.github.com/tecosaur/org-knit-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244799345,"owners_count":20512237,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-actions","org-mode","publishing"],"created_at":"2024-10-11T21:42:00.916Z","updated_at":"2025-03-21T12:31:22.024Z","avatar_url":"https://github.com/tecosaur.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"#+title: Org knit\n#+author: TEC\n#+property: header-args:yaml :tangle \"demo.yml\"\n\nLet someone else take care of keeping up to date tangled/woven versions of your\nOrg files for public consumption.\n\n#+begin_src yaml\n- name: Export org files\n  uses: tecosaur/org-knit-action@v0.3\n  with:\n    github_token: ${{ secrets.GITHUB_TOKEN }}\n#+end_src\n\n* Parameters\n+ =parameter= (=default=) :: description\n** Parameter types\n+ boolean :: can be =true= / =false= or =yes= / =no=\n+ list :: can be a single value, comma separated values (without quotes), or a\n  python list as a string.\n** Exporting\n+ =config= (boolean or list: =false=) :: Path to either an =init.el= file, or a\n  repository url (i.e. ends with =.git=) for =~/.emacs.d=.\n  This also recognises Doom configuration repositories (=~/.config/doom=).\n+ =setup_file= (boolean or list: =false=) :: URL for a =#+setupfile= to use in all Org files.\n+ =eval= (boolean or list: =false=) :: Whether to evaluate code in Org files. Also accepts a list of\n  globs specifying which Org files should be evaluated.\n+ =tangle= (boolean or list: =false=) :: Whether to run ~org-tangle~ for each Org file. Also accepts a list of\n  globs specifying which Org files should be tangled.\n+ =export= (list: =html=) :: Comma separated list of formats to export to.\n+ =files= (list: =**/*.org=) :: List of org file globs to act on.\n** Publishing\n+ =github_token= (string) :: The =GITHUB_TOKEN= secret. Required to push any result.\n+ =branch= (string: default branch) :: The branch to push files to\n+ =force_orphan= (boolean: =false=) :: Force-push the created commit as the only commit on\n  the branch.\n+ =keep_files= (boolean or list: =true=) :: Whether to include non-org-related files. Also accepts a\n  list of globs.\n+ =commit_message= (string: =Knit: !#!=) :: Commit message to use. =!#!= is replaced with the\n  triggering commit hash.\n+ =fragile= (boolean: =true=) :: Fail the action if any export/tangle steps fail.\n\n* Example actions\nIn each of the examples below, a simple preamble like so is assumed.\n#+begin_src yaml\nname: \"Export\"\non: [push]\n\njobs:\n  export:\n    runs-on: ubuntu-latest\n    - name: Checkout\n      uses: actions/checkout@v2\n#+end_src\n\n** Export to HTML documentation\n#+begin_src yaml\n    - name: Export Org files to GitHub Pages\n      uses: tecosaur/org-knit-action@v0.3\n      with:\n        github_token: ${{ secrets.GITHUB_TOKEN }}\n        branch: gh-pages\n        # add PDFs\n        # export: html, pdf\n#+end_src\n\n** Include tangled files in Repository\n#+begin_src yaml\n    - name: Tangle Org files\n      uses: tecosaur/org-knit-action@v0.3\n      with:\n        github_token: ${{ secrets.GITHUB_TOKEN }}\n        tangle: yes\n#+end_src\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftecosaur%2Forg-knit-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftecosaur%2Forg-knit-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftecosaur%2Forg-knit-action/lists"}