diff --git a/README.md b/README.md index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..7ccdbf71aa74dae7bc0c61e68353680d724aa8a8 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,28 @@ +## nomad-distro + +nomad-distro handles deployments for Central NOMAD and related environments. It allows plugin configuration, nightly updates, and manual deployments for staging and production. + +### Steps for Deployment + +1. Configure Plugins: + + a. Update the plugins in pyproject.toml. + + b. Generate the requirements file: + +```bash + ./scripts/generate_python_requirements.sh +``` + +2. Create Merge Requests (MRs): + +- For Central NOMAD: MR to the main branch. +- For Test-Oasis: MR to the test-oasis branch. + +### Nightly Deployments (Automatic): + + Updates nomad-lab package and redeploys nightly to develop and test-oasis. + +### Manual Deployments: + + Staging/Production: Trigger manually after new releases.