search

ammaraskar / sphinx-action

Github action that builds docs using sphinx and places errors inline
Apache License 2.0
189 stars 114 forks source link

Feat/sphinx synch #56

Closed nicholasphair closed 4 months ago

nicholasphair commented 4 months ago

Adds a commit for each version of the sphinx docker image.

Users just need to point to the commit or tag they want to use. For instance, I tested a sphinx 7.0.0 build with:

 - uses: nicholasphair/sphinx-action@7.0.0
    with:
      docs-folder: "docs/"

Also adds a daily workflow to compare against the latest release of the sphinx docker and crafts a new commit+tag object that uses it.

Relevant to any issue asking for a newer version.

nicholasphair commented 4 months ago

@ammaraskar I did read your concerns in #55 about breaking users builds if master is moved off of 2.4.5. And this would do that. However, with this tagging approach, If you really wanted, you could leave master on 2.4.5 forever and still support newer versions.

That said, my contention would be to move master ahead and risk the broken builds. This is the same thing that happens when users use the latest tag in docker and why people warn against it. Fortunately, anyone expecting 2.4.5 can fix their build easily by changing from ammaraskar/sphinx-action@master to ammaraskar/sphinx-action@2.4.5 (given that the tags are in place).

ammaraskar commented 4 months ago

Hi Nicholas! Thank you so much, this is awesome and I think this seems to be the right way to move forward. It'll probably be a little bit till I can take a look at this but I've gone ahead and added you as a collaborator on the repo if you'd like to push it yourself.

nicholasphair commented 4 months ago

My pleasure @ammaraskar. Thanks for the project :)

Perhaps later tonight or tomorrow I can try to push. I'll probably want to update the README to help anyone whose build breaks recover.

Thanks again!