DiamondLightSource / DiamondLightSource/blueapi

Document deployments and rollbacks of BlueAPI with a scratch folder

Open
#1,066 2 comments 0 reactions 0 assignees View on GitHub
deployment documentation
Dominant language
Python
Stars
13
Forks
13
Avg merge
2d 11h
Merged PRs (30d)
25

Description

Deploying a new version of BlueAPI is currently a bit fiddly, and would benefit from a how to guide, or potentially from a slight change into out setup-scratch works.

A few points:
- BlueAPI errors if the scratch path doesn't exist - maybe it should create the scratch folder if it doesn't already exist?
- The scratch folder needs to have extra permissions for setup-scratch to be successful (I needed to run `chmod o+wrX -R`). If BlueAPI is in charge of creating scratch then this can be done automatically, otherwise it should be documented
- It would be neat if rolling back a BlueAPI version would also roll back the versions of dodal and the plan repo. We should document whether or not this is a planned feature, as well as the current approach as to how to roll everything back

## Acceptance Criteria
- Above bullet points are addressed

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.