Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update & improve instructions for GitHub-hosted deps

Browse Source 
They have fallen out of date since we switched from Jenkins-
run upgrades to GitHub Actions -run upgrades.
This commit is contained in:
Kyle McCormick
2022-09-19 13:17:48 -04:00
committed by Kyle McCormick
parent c20aa28c2f
commit edfd66498b
1 changed files with 22 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
requirements/edx/github.in
View File

@@ -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/<YOUR_REPO>/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