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

Require/enforce "main" or "permalink" algorithm references #48

Open
soxofaan opened this issue Oct 28, 2024 · 3 comments
Open

Require/enforce "main" or "permalink" algorithm references #48

soxofaan opened this issue Oct 28, 2024 · 3 comments

Comments

@soxofaan
Copy link
Contributor

soxofaan commented Oct 28, 2024

Observation from reviewing #44:
some references use feature branch references: e.g.

  • algorithm_catalog/eurac_pv_farm_detection.json refers to https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/hv_pv_detection/openeo_udp/eurac_pv_farm_detection/eurac_pv_farm_detection.json
  • benchmark_scenarios/eurac_pv_farm_detection.json refers to https://raw.githubusercontent.com/ESA-APEx/apex_algorithms/refs/heads/hv_pv_detection/openeo_udp/eurac_pv_farm_detection/eurac_pv_farm_detection.json

note that both of these contain refs/heads/hv_pv_detection which means that they track the feature branch hv_pv_detection of the PR itself. These references will break once the hv_pv_detection feature branch is removed.

Can/should we enforce pinned references (called "permalink" in the github UI) and/or main branch references? This could be handled as pre-commit things and in unit tests

@HansVRP
Copy link
Contributor

HansVRP commented Oct 30, 2024

It is also somewhat inconvenient for entry users to retrieve such a link. For future versions it could be useful to explore how this could be facilitated to automated.

@soxofaan
Copy link
Contributor Author

Possible solution would be to allow relative references instead of full absolute URLs during PR-phase.
Once merge in master we could work out some system to change the relative references to absolute/pinned URLs

@soxofaan
Copy link
Contributor Author

I already added linting checks against using feature branch references in algorithms, benchmarks, UDPs

next step would be to automatically suggest a fixed URL

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

No branches or pull requests

2 participants