From edfd66498b78ebcb8dcc7eaa8ff249a79094089c Mon Sep 17 00:00:00 2001 From: Kyle McCormick Date: Mon, 19 Sep 2022 13:17:48 -0400 Subject: [PATCH] docs: update & improve instructions for GitHub-hosted deps They have fallen out of date since we switched from Jenkins- run upgrades to GitHub Actions -run upgrades. --- requirements/edx/github.in | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) diff --git a/requirements/edx/github.in b/requirements/edx/github.in index 2180744c14..e789ed2351 100644 --- a/requirements/edx/github.in +++ b/requirements/edx/github.in @@ -1,16 +1,30 @@ -# DON'T JUST ADD NEW DEPENDENCIES!!! +# This file holds all GitHub-hosted edx-platform Python dependencies. +# Such dependencies should be added here, not to base.in. +# That being said.... # -# If you open a pull request that adds a new dependency, you should: +# ---->>> DON'T JUST ADD NEW DEPENDENCIES!!! <<<---- +# +# We are working to move all dependencies here to proper PyPI-hosted +# projects that can be specified in base.in (or development.in, etc). +# Every new GitHub-hosted dependency slows down the edx-platform build and +# subverts our continuous dependency upgrade process. This file should +# only be added to in exceptional circumstances. +# +# "I don't have time to publish my package to PyPI" is **not** an +# acceptable excuse. You can add a GitHub Action workflow to automatically +# upload your package to PyPI with the push of a button: +# +# * Go to https://github.com/openedx//actions/new +# * Find "Publish Python Package" +# * Merge the generated PR and push package. +# * You're done! Add your dependency to base.in, and the requirements +# bot will automatically keep it fresh in edx-platform. +# +# If you must open a pull request that adds a new git dependency, you should: # * verify that the dependency has a license compatible with AGPLv3 # * confirm that it has no system requirements beyond what we already install # * run "make upgrade" to update the detailed requirements files # -# Do *NOT* install Python packages from GitHub unless it's absolutely necessary! -# "I don't have time to add automatic Travis upload to PyPI." is *not* an -# acceptable excuse. Non-wheel module installations slow down the dev/building process. -# Travis/PyPI instructions are here: -# https://openedx.atlassian.net/wiki/spaces/OpenOPS/pages/41911049/Publishing+a+Package+to+PyPI+using+Travis -# # A correct GitHub reference looks like this: # # git+https://github.com/OWNER/REPO-NAME.git@TAG-OR-SHA#egg=DIST-NAME==VERSION