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

Pin Sphinx version and make Netlify happy #1445

Closed
wants to merge 5 commits into from
Closed

Conversation

ksuess
Copy link
Member

@ksuess ksuess commented Jun 9, 2022

No description provided.

Make Netlify happy
@mister-roboto
Copy link

@ksuess thanks for creating this Pull Request and helping to improve Plone!

TL;DR: Finish pushing changes, pass all other checks, then paste a comment:

@jenkins-plone-org please run jobs

To ensure that these changes do not break other parts of Plone, the Plone test suite matrix needs to pass, but it takes 30-60 min. Other CI checks are usually much faster and the Plone Jenkins resources are limited, so when done pushing changes and all other checks pass either start all Jenkins PR jobs yourself, or simply add the comment above in this PR to start all the jobs automatically.

Happy hacking!

@netlify
Copy link

netlify bot commented Jun 9, 2022

Deploy Preview for plone-restapi ready!

Name Link
🔨 Latest commit 225593f
🔍 Latest deploy log https://app.netlify.com/sites/plone-restapi/deploys/64e85d1150fa5c0007ce294b
😎 Deploy Preview https://deploy-preview-1445--plone-restapi.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@@ -2,4 +2,4 @@
PYTHON_VERSION = "3.8"

[build]
ignore = "git diff --quiet $CACHED_COMMIT_REF $COMMIT_REF ./docs/"
ignore = "git diff --quiet $BRANCH $HEAD -- ./docs/source/"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comparing the changes on the branch. This has the effect, that the preview is done or at least kept, even when a further commit to the branch does not include any changes in /docs/source/.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Netlify log says fatal: bad revision 'pull/1445/head':

https://app.netlify.com/sites/plone-restapi/deploys/62a194ddac9c4d0008ab7e5a#L14

It still builds, so maybe it is OK? ¯\_(ツ)_/¯ Or perhaps it builds for every commit, and not only for changes in /docs/source? You can test by pushing two trivial commits, one with a change in /docs/source only, and one outside.

I also checked the Netlify logs, and it was building only for changes inside /docs/source/ up until this change. It's possible it was a one-time fluke.

While we're looking at this directory, can you delete /docs/requirements.txt? It has been replaced by /requirements-docs.txt.

@ksuess ksuess requested a review from stevepiercy June 9, 2022 06:42
Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to test diffs with the new Netlify configuration. See comment.

Also remove obsolete file.

@@ -2,4 +2,4 @@
PYTHON_VERSION = "3.8"

[build]
ignore = "git diff --quiet $CACHED_COMMIT_REF $COMMIT_REF ./docs/"
ignore = "git diff --quiet $BRANCH $HEAD -- ./docs/source/"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Netlify log says fatal: bad revision 'pull/1445/head':

https://app.netlify.com/sites/plone-restapi/deploys/62a194ddac9c4d0008ab7e5a#L14

It still builds, so maybe it is OK? ¯\_(ツ)_/¯ Or perhaps it builds for every commit, and not only for changes in /docs/source? You can test by pushing two trivial commits, one with a change in /docs/source only, and one outside.

I also checked the Netlify logs, and it was building only for changes inside /docs/source/ up until this change. It's possible it was a one-time fluke.

While we're looking at this directory, can you delete /docs/requirements.txt? It has been replaced by /requirements-docs.txt.

@tisto
Copy link
Member

tisto commented Aug 25, 2023

@stevepiercy @ksuess status?

# Conflicts:
#	docs/source/conf.py
#	docs/source/endpoints/users.md
#	requirements-docs.txt
@stevepiercy
Copy link
Contributor

@tisto I merged master to this branch, fixed merge conflicts, and pushed. Let's see what Netlify builds.

@davisagli
Copy link
Member

We switched from Netlify to Read the Docs in #1798, so this is outdated.

@davisagli davisagli closed this Sep 5, 2024
@davisagli davisagli deleted the pin-sphinx-version branch September 5, 2024 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

5 participants