Skip to content
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

User-defined "pinned versions" for JEDI repos #38

Merged
merged 30 commits into from
Jun 28, 2024

Conversation

asewnath
Copy link
Collaborator

@asewnath asewnath commented Jun 14, 2024

Description

Adding ability for an optional pinned version config file to override defaults in jedi_bundle.

Example pinned version config file:

- ufo:
    branch: 64655cf61a9d22c88c0f20e740554ca5225790bc 
    commit: True

New config field commit is introduced to specify if the given branch is a hash. This follows the yaml configuration style in jedi_bundle's default configs. Note that the pinned version config file can also handle branches and tags.

Pinned version config file is saved in jedi_bundle and can be invoked with these flags:
jedi_bundle --pinned_versions
jedi_bundle -pv

Contents of the pinned versions config file is added to build.yaml. Then, the Clone task proceeds as normal with the build.yaml file.

See issue for more information: GEOS-ESM/swell#345

@asewnath
Copy link
Collaborator Author

TODO add github actions test for pinned version case

@Dooruk
Copy link
Collaborator

Dooruk commented Jun 18, 2024

Hi @asewnath , just saw this but I didn't receive any notifications. Is it ready for testing?

@asewnath
Copy link
Collaborator Author

Hi @asewnath , just saw this but I didn't receive any notifications. Is it ready for testing?

Hi @Dooruk, I haven't added the github action test for this yet but technically it's ready for testing

@asewnath asewnath requested review from ashiklom and Dooruk June 20, 2024 18:15
@asewnath asewnath requested a review from ashiklom June 25, 2024 20:38
Copy link
Contributor

@ashiklom ashiklom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm pretty sure import typing is not necessary to enable type hinting, so I recommend removing it (from git.py). The hints are ignored by the runtime anyway, so it doesn't really do anything. I think you mostly import typing for specific functions or classes -- e.g., from typing import Union.

Otherwise, this is good to go. Nice work! This will be a really useful change to making SWELL work more reliably and giving us more control over our integration with JEDI.

@ashiklom ashiklom merged commit ba8cb07 into develop Jun 28, 2024
7 checks passed
@asewnath asewnath deleted the feature/pinned_versions branch June 28, 2024 13:30
@asewnath
Copy link
Collaborator Author

I'm pretty sure import typing is not necessary to enable type hinting, so I recommend removing it (from git.py). The hints are ignored by the runtime anyway, so it doesn't really do anything. I think you mostly import typing for specific functions or classes -- e.g., from typing import Union.

Otherwise, this is good to go. Nice work! This will be a really useful change to making SWELL work more reliably and giving us more control over our integration with JEDI.

Ah okay good to know! I thought import typing was required

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants