-
Notifications
You must be signed in to change notification settings - Fork 0
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
feat: use composite actions for python scripts #22
Draft
mariajgrimaldi
wants to merge
31
commits into
main
Choose a base branch
from
MJG/maintainable-scripts
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains 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
mariajgrimaldi
changed the title
temp: try using composite action for scripts
feat: use composite actions instead hard-coded scripts
Sep 27, 2024
mariajgrimaldi
changed the title
feat: use composite actions instead hard-coded scripts
feat: use composite actions for python scripts
Sep 28, 2024
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 is a continuation of a proposal I made here about making scripts more maintainable in the long term. I mentioned I had to figure out a good way of calling scripts within our workflow. Here's what I came up with:
Python scripts hosted in
.github/workflows/actions
The additional functionalities with complex logic for the workflow should be implemented in a Python script hosted in a subdirectory within
.github/workflows/actions
with an explicit name containing its purpose. In this case, the script gets tutor configuration values, so the folder is called get-tutor-config, just like the Python script. Each script should be well-documented and modular, have a single responsibility, and be able to be executed locally for easier debugging.Composite actions running Python scripts
For this setup to work, we'd have to modify the workflow by:
I consider this approach to be more maintainable since we can now easily lint, test, and debug scripts. However, I understand it adds more layers of complexity, although easy to implement and use. The composite actions within
.github/workflows/actions
are meant to be small and straightforward since the only code added is a shell script executing a Python script. Therefore, the Python script should handle all complex logic to avoid returning to our previous situation.This implementation is not set in stone, so feedback is very welcome.