add details to request workflow

This commit is contained in:
2020-12-15 17:05:04 +01:00
parent c0d6cb6fbe
commit 3564d9bdf8

View File

@@ -2,6 +2,40 @@
This repository holds the requested bsread data sources and their data policies of the SwissFEL Data Buffer.
# Workflow - Request New Sources / Change Sources
This is the workflow
1. Create a forked repository of the current databuffer configuration repository and clone it to your home folder:
```bash
ssh sf-lc7.psi.ch
cd ~
gitutils fork -c archiver_config/sf_databuffer
```
2. Go to the cloned repository and add/edit the files needed
```bash
cd ~/sf_databuffer
...
```
3. Commit your changes in the cloned local copy and push the changes to the server.
```bash
git commit -a -m "my commit message"
git push
```
4. Use `gitutils` to create automatically a merge request to the main repository on the git server.
```bash
gitutils merge -t "My Changes" -d "my merge request message"
```
Be aware: The best is to wait until a merge request was approved/closed before you create/open a new one!
More details on the gitutils command can be found at: https://gitutils.readthedocs.io/en/latest/
# Administration
If there are new changes to this configuration (either through a merge request or direct commit) the configuration needs to be uploaded to the Data/ImageBuffer. To do so clone or pull the latest changes from this repository and execute the `./upload.sh` script that comes with this repository.