Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/sphinx synch #56

Merged
merged 60 commits into from
Feb 29, 2024
Merged

Conversation

nicholasphair
Copy link
Collaborator

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
Copy link
Collaborator Author

@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
Copy link
Owner

ammaraskar commented Feb 28, 2024

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
Copy link
Collaborator Author

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!

@nicholasphair nicholasphair changed the base branch from master to dev February 29, 2024 05:05
@nicholasphair nicholasphair merged commit 204217f into ammaraskar:dev Feb 29, 2024
chrisbrickhouse added a commit to chrisbrickhouse/FAVE that referenced this pull request Mar 13, 2024
The builds were failing because the sphinx-action used by our workflow
defaulted to Sphinx 2.2.0 regardless of what was in the pyproject.toml
The current solution according to ammaraskar/sphinx-action#56 is to use
a tag corresponding to the sphinx version you want to use.
chrisbrickhouse added a commit to JoFrhwld/FAVE that referenced this pull request Mar 13, 2024
The builds were failing because the sphinx-action used by our workflow
defaulted to Sphinx 2.2.0 regardless of what was in the pyproject.toml
The current solution according to ammaraskar/sphinx-action#56 is to use
a tag corresponding to the sphinx version you want to use.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants