Git Product home page Git Product logo

github-actions-latex-pdf-template's Introduction

LaTeX document template

This is a template repository containing a LaTeX stub document for collaborative work on research projects. It supports automatic deployment of the .pdf document as well version control/labeling of the said document via gitinfo2.

Build status

build

The latest document file is available here

NOTE: do not forget to change the link in your own version of the repository.

WIP & Contributions

This is a WIP project, it works but still requires a lot of polishing. You're welcome to take a look at the issues and suggest a fix/improvement.

The original workflow script is adapted from this example by Davide Gerosa.

How to use

Use it as any other template repository. Do not forget to adjust the README file accordingly and mention the original project somewhere.

Copyright

2022, University of Glasgow

github-actions-latex-pdf-template's People

Contributors

dependabot[bot] avatar vkhodygo avatar

Watchers

 avatar

github-actions-latex-pdf-template's Issues

MAINT: correct license

MIT might be the best choice, still, including other projects requires a legal advice.

ENH: improve workflow structre and triggers

The script in use triggers when a push is accompanied by a tag at the moment. It has to be changed so that it starts when there is a change to the repo files only.

  • draft document - every repo change
  • release build - when there is a new tag only

This saves a lot of resources and time. It would be also great to have separate filenames for drafts/releases as well as commits/tags in the aforementioned names.

ENH: Improve actions script performance

Currently, it takes about 2 minutes to build the document which is unacceptable.
The reason for this is that GitHub doesn't offer a default solution for LaTeX-based actions.

Replacing the custom LaTeX action with the default ubuntu-latest might improve the results, but it has to be tested first.

TEST, ENH: local workflow tests via `act` fail to work with some actions

The act package is a nice tool for local tests, however, it is based on docker which is infamous for its issues with root permissions.
Some of the actions used here prevent act from being used meaning every change in the code has to be pushed to see if it works.
This seriously increases the overall time of development.

Again, this issue requires some investigation first.

ENH: similar projects

Apparently, there are other projects of this kind: here and here. The former is based on Travis CI and is of no relevance (and seems to be no longer maintained), the latter is: a fork of the first one, too massive, and doesn't seem to have all the required features.

Either way, they both have to be checked for nice ideas if any.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.