AllenNeuralDynamics / AllenNeuralDynamics/aind-ophys-motion-correction

Dynamically update pipeline and code version in processing.json

Offen
#28 0 Kommentare 0 Reaktionen 1 zugewiesene Person Beansprucht von @arielleleon Auf GitHub ansehen
Vorherrschende Sprache
Python
Sterne
1
Forks
1
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Pipeline and code version are manually added. From Jake V (Code Ocean):

Code and pipeline versions are manually entered in the processing json. The code version is never truly up to date. Jake has posted a way to get around this with the following steps:

Here are a few code snippets that may be helpful to track what capsule commits are used by your pipeline. They assume you have jq installed and have your Code Ocean API token attached as a custom key secret.

At runtime every capsule will have its capsule ID as the environment variable CO_CAPSULE_ID. You can use the Code Ocean API to get the capsule's metadata:

get_capsule_metadata=$(curl -s -H "Content-Type: application/json" -u ${CUSTOM_KEY}: -X GET [https://codeocean.allenneuraldynamics.org/api/v1/capsules/${CO_CAPSULE_ID}](https://codeocean.allenneuraldynamics.org/api/v1/capsules/$%7BCO_CAPSULE_ID%7D))

If it's a release capsule, one of the fields of the API response is versions which you can use to document what capsule version is used in your pipeline, e.g. echo $get_capsule_metadata | jq -r '.versions' >> ../results/processing.json

If it's not a release version but your capsule is backed by a GitHub repo, one of the fields in the API response is cloned_from_url which is your GitHub repo's URL. Then you can use the GitHub API to get the info on the latest commit, e.g. latest_commit=$(curl -s https://api.github.com/repos/AllenNeuralDynamics//commits | jq -r '.[0] | {sha: .sha, author: .commit.author.name, date: .commit.author.date, message: .commit.message}')

The pipeline version can be pulled using the CO API.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.