Skip to content

How to deploy the tool

Giovanni Pizzi edited this page Nov 25, 2020 · 3 revisions

How to update the code

  1. Create a branch
  2. Push your commits, make sure tests pass
  3. Create a PR and merge it in master (required by branch protection rules)

How to push to the development server

  1. (Only the first time) Add a git remote dev-dokku to your git repo, pointing to dokku@matcloud.xyz:layer-raman-ir
  2. Run git push dev-dokku from the master branch

Pushing to the development server can be done at any time, as it is acceptable that it might not work at times, even if it is suggested to test it locally using the ./admin-tools/build-and-run.sh script (that is also faster since it will use the docker cache)

How to release a new production version

  1. Create a branch
  2. Update the version in the __version__ variable inside compute/layer_raman_engine.py
  3. Merge into master with a pull request
  4. Create a git tag using CalVer, e.g. vYY.MM.N, where YY is the two-digit year, MM is the two-digit month, and N is a sequential number starting from 0 for every release in that month. E.g., for the v20.11.0 release, you can type git tag v20.11.0 (check the tags first with git tag -l)
  5. Push the tag to GitHub with git push --tags
  6. Possibly mark it as a new release from the GitHub GUI
  7. (Only the first time) Add a git remote prod-dokku to your git repo, pointing to dokku@materialscloud.io:layer-raman-ir
  8. Push the tagged commit to prod-dokku with git push prod-dokku