You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/how-to/copier_update.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ source venv/bin/activate
18
18
pip install copier
19
19
```
20
20
21
-
NOTE: generic IOCs with a given major version number template should work with beamline repos with the same major version number template. When updating to a new major version, you may also need to update the generic IOCs it references. If this is the case it will be noted in [](../reference/changelog.md). Having said this, the two types of repo are reasonably well decoupled and we would aim to avoid this necessity. In which case update the beamline repo first and then the generic IOCs as and when new features are required.
21
+
NOTE: generic IOCs with a given major version number template should work with beamline repos with the same major version number template. When updating a beamline repo to a new major version, you may also need to update the generic IOCs it references. If this is the case it will be noted in [](../reference/changelog.md). Having said this, the two types of repo are reasonably well decoupled and we would aim to avoid this necessity. In which case update the beamline repo first and then the generic IOCs as and when new features are required.
22
22
23
23
Updating a Beamline Repository
24
24
------------------------------
@@ -43,6 +43,8 @@ For example, in version 3.4.0 the `ec-services-template` changed the way that th
43
43
Updating a Generic IOC Repository
44
44
---------------------------------
45
45
46
+
To see details of how to initially create a generic IOC repository see {any}`create_generic_ioc`.
47
+
46
48
To update your generic IOC repository to the latest version of the templates you should run the following command in the root of your repository:
47
49
48
50
```bash
@@ -77,7 +79,7 @@ In both cases you should select Y for each notice of a conflict, then resolve th
77
79
78
80
Using copy will mean that you get asked the template questions again, but copier is smart enough to supply your previous answers as defaults (if your repo predates copier then you will need to answer all the questions for the first time).
79
81
80
-
The difference from 'update' is that you will need to do the merge yourself. For example in a generic IOC you will want to restore your support module instantiations in the middle of the Dockerfile, whereas the top and bottom of the Dockerfile will should be updated by the template. Using vscode's SOURCE CONTROL pane is useful for this. The following image is an example of a Dockerfile merge:
82
+
The difference from 'update' is that you will need to do the merge yourself. For example in a generic IOC you will want to restore your support module instantiations in the middle of the Dockerfile, whereas the top and bottom of the Dockerfile should be updated by the template. Using vscode's SOURCE CONTROL pane is useful for this. The following image is an example of a Dockerfile merge:
Copy file name to clipboardExpand all lines: docs/tutorials/generic_ioc.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,7 @@ Much like creating a new beamline we have a template project that can be used
52
52
as the starting point for a new Generic IOC. Again we will create this in
53
53
your personal GitHub user space.
54
54
55
-
55
+
(create_generic_ioc)=
56
56
## Steps
57
57
58
58
1. Go to your GitHub account home page. Click on 'Repositories' and then 'New', give your new repository the name `ioc-lakeshore340` plus a description, then click 'Create repository'.
0 commit comments