GeezerVison

If it's not much of a hassle, I would appreciate it if someone could @ mention me when this PR is merged. I'll be mentioning the netlify preview in my PR for the devguide as a part of verifying rich formatting in NEWS entries.

It might be worthwhile to also mention it somewhere in https://devguide.python.org/documenting/.

If it's not much of a hassle, I would appreciate it if someone could @ mention me when this PR is merged. I'll be mentioning the netlify preview in my PR for the devguide as a part of verifying rich formatting in NEWS entries.

@aeros167 It's probably better for you to click Notifications on the right sidebar which will subscribe you to changes in the PR 😄

It might be worthwhile to also mention it somewhere in https://devguide.python.org/documenting/.

Yes it would 👍

@aeros167 It's probably better for you to click Notifications on the right sidebar which will subscribe you to changes in the PR smile

Haha, good point. I recently changed my notification settings to only notify me via email for @ mentions (since I was getting a bit over-flooded w/ GitHub emails), but I could probably have it different for specific PRs. I previously had it set to "Watching" for any PR that I reviewed or commented in.

Also, I hadn't realized that the "Releases only" setting was an option, which notifies only for @ mentions and releases. That should do the trick. (:

Since this change is involving the addition of a development tool to the repository and it wouldn't affect users of Python, I'll add a skip news label.

Thanks again for the PR @epicfaace and thanks for merging it @willingc. I'll go update my PR for the devguide.

An admin now needs to actually add Netlify as an app to this repository so that it can start running and building the docs.

An admin now needs to actually add Netlify as an app to this repository so that it can start running and building the docs.

I'm not certain if there's a specific person that manages the repository's apps, so I'll notify all of the admins for CPython.

/cc @python/cpython-repository-admins

@epicfaace have a link to the GitHub App for Netlify?

@epicfaace have a link to the GitHub App for Netlify?

@brettcannon I think the easiest way to integrate it is to sign in to netlify.com with whichever account Python is using. You can use the same Netlify account that's being used with https://github.com/python/devguide. Then, you can add this repo as a "site" on netlify, and then it should ask for permission with the appropriate scopes. See https://www.netlify.com/docs/github-permissions/

@epicfaace not aware of any account, so I don't know what you're talking about. 😄 @ewdurbin do you know/control the netlify account for the org?

For reference, here's the original thread where it was set up for devguide: python/devguide#463

😟 the devguide netlify was actually set up under my personal netlify account.
I could not figure out how to transfer that to a different account.

If the PSF can create the netlify account and add me to it as a team member, I can help manage and create the netlify for CPython.

I've set up an open source site on Netlify before. You need to contact Support and then they will give your account access to create a "Team". Then, you can add people to the team and create sites on it.

Note that in order to qualify for this, you must have a badge that links to Netlify on the deployed site. (They suggest you add a "deploys by Netlify" badge, so it seems like this requirement would only apply to the version of the site that is deployed by Netlify, i.e. the deploy previews)

https://www.netlify.com/legal/open-source-policy/

Otherwise, using a personal account on Netlify doesn't give you the ability to share permissions/management with others.

I'm eager to see this feature employed. Today, I'm reviewing GH-17730, and I'd love to see the rendered output without building the toolchain or downloading the zip file and expanding it locally.

@Mariatta how could we go forward with this? Could we just set this up as part of your personal netlify account (although it's not ideal, at least then the devguide and cpython repos will both be under your account, so that they could later be transferred together to a PSF account)?

@epicfaace we would need @ewdurbin to set up a PSF-managed Netlify account.

I've contacted Netlify to inquire about setting up a PSF team on the service. It looks like their free tier has changed and probably would not support the needs of this repo both in build minutes and collaborator count.

@ewdurbin I assume you're talking about the "Pro" tier, correct (which is what Netlify provides to open-source teams for free) (1000 build minutes included/month and 3 collaborators included)? What values of build minutes / collaborator count do you think would be required for this repo?

Howdy! I heard back from netlify and we have access to a Pro level account now through their Open Source Plan Policy.

To get some bearings, I temporarily enabled it for this repository and opened a test pull request at #18242, which resulted in a working preview build 🎉.

Overall it seems to work with that minor tweak, but the limitations of the Pro level plan will likely need to be addressed:

1000 build minutes per month

I'm not sure if it's a cold cache kind of situation, but from the logs of a few test deploys (example) I noticed that cloning alone is taking over a minute per build, followed by another 5-6 minutes to install dependencies and build the docs.

This means that we can currently expect to get ~170 preview builds per month before reaching our limit and beginning to incur charges of $7/500 additional build minutes.

3 concurrent builds

This is a pretty active repository, so this would likely just be a headache at times. Probably not a blocker.

3 team members

Probably not an issue, I'd just need to know who to add.

Given those, I think we'd need to investigate some way to handle the limitations above (and figure out why the change in #18242 was necessary) before turning this on.

Thanks for reaching out to netlify on this @ewdurbin!

Assuming we can find a way around the monthly build time limits, this will be an awesome feature for documentation PRs; especially for larger ones that include a significant amount of markdown. For example, the "What's New" documentation often contains broken Sphinx roles (with correct syntax, but an incorrect link). These could be caught much easier with the netlify preview.

One possible solution would be to use the preview selectively for documentation PRs, via a manually applied label (which would be configured to trigger a webhook). For example: test-with-netlify, similar to the recently added test-with-buildbots. As long as the limit is a concern, the label would have to be manually added by either Python core developers or members of the Triage team for PRs that would substantially benefit from having the netlify preview.

In the future if we're able to increase the monthly build limit substantially (to either unlimited or high enough that we'd never reasonably reach it), we could potentially configure @bedevere-bot to automatically add the above test-with-netlify whenever a PR includes changes to any file to the Doc/ directory in the CPython repository.

Given the limitations of using Netlify, I've added a PR with an alternative approach using GitHub Actions in the issue (https://bugs.python.org/issue37860). Any thoughts on this approach?