The CLAMS App Directory is a public registry for free and open CLAMS apps, available at https://clamsproject.github.io/apps.
The App Directory accepts submissions of CLAMS apps. All submitted apps must follow the CLAMS app interface specification. In a nutshell, at the minimum,
First and foremost note that, at the moment, all the submissions are manually reviewed by the CLAMS team, hence the process can take some time.
Here is a step-by-step guide on how an app submission works:
clamsproject
GitHub organization)If you started developing the app using the clams develop
cookie cutter, the app submission process is very simple.
Push a git tag to your app code repository organized under the clamsproject
GitHub organization.
If you want to leave a release note make the tag annotated and write the note in markdown syntax as the tag message.
The App Directory will use the tag name as the app version, and the tag message as the app release note.
Once you push the tag, a GH actions workflow included in the cookie cutter will automatically
clamsproject
GitHub Container RegistryMore on the git tag.
v
prefix (e.g., v1
, v2.0
, v240630
). As long as the tag name is unique and numerical, you can use any form you like.If you are an external contributor, you can submit an app to the directory by manually opening an issue on the App Directory repository.
metadata.py
script in the project root that generates app metadata JSON string when directly run (python metadata.py
).
After the submission, the CLAMS team will review the app and the metadata. If the app is accepted, the team will merge the PR, and the app will be listed on the directory. If the app is rejected (mostly for mis-aligned app metadata), the team will close the PR with a reason for rejection. In such a case, the developer can re-submit the app after fixing the issues. Note that, while the PR is open (i.e., the app is under review), a developer cannot re-submit the same app (the GitHub action we use to create an app submission PR will produce errors when duplicate app submission is detected). If the developer wants to fix any problems or update the app, they can close the PR (if they are a part of the CLAMS team) or ask the CLAMS team to close the PR (if they are an external contributor).
The re-submission process is simply to delete the tag from the remote app code repository and re-create the tag on the updated git commit. If the original submission was via a GH issue, the re-submission process is to create a new issue with the updated tag/commit and container image URL.