feat: add support for private requirements #13
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
magajh
requested changes
Nov 10, 2025
Contributor
magajh
left a comment
magajh
left a comment
There was a problem hiding this comment.
Thank you for this, @andrey-canon! Just a couple of comments
| openedx_imports_test_file_path: | ||
| description: 'Path to the file that contains the test function for validating Open edX imports. This should be a Python file within your project.' | ||
| required: false | ||
| ssh_private_key: |
Contributor
There was a problem hiding this comment.
Let's please make this a secret instead of a regular input
| shell: bash | ||
|
|
||
| - name: Setup SSH agent for private repositories cloning | ||
| if: ${{ inputs.ssh_private_key }} |
Contributor
Author
There was a problem hiding this comment.
| tutor local start -d lms cms | ||
| shell: bash | ||
|
|
||
| - name: Pip install private requirements inside LMS and CMS |
Contributor
There was a problem hiding this comment.
Can we please move this step to before or after the step where we install the extra requirements
integration-test-in-tutor/action.yml
Line 227 in a5cb1cc
Contributor
Author
There was a problem hiding this comment.
why? anyway, that will make that some implementations fail, there are two options
- you need a private requirement that is not an app requirement, this will work with your suggestion
- you need a private requirement that is an app requirement, when the app(plugin) is installed in the next step the installation will fail since that won't be able to install the private dependency
|
|
||
| **Optional** | ||
| A private SSH key (usually stored as a GitHub Secret) that allows cloning of private repositories containing additional Open edX requirements. | ||
| * *Example*: `${{ secrets.SERVICE_USER_SSH_KEY }}` |
Contributor
There was a problem hiding this comment.
Please remember to update this with the correct secret name
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR extends the Open edX Plugin Integration Tests with Tutor GitHub Action to support installing private requirements from SSH-based Git repositories inside the Tutor LMS and CMS environments.
Key Changes
New Inputs
New Steps
Purpose
These additions allow the action to handle private Python package dependencies that are not available on PyPI, ensuring that plugins depending on private repositories can be fully tested within the Tutor environment.