|
3 | 3 | This template uses the code-scaffolding tool [copier](https://copier.readthedocs.io/) to create a [LinkML](https://github.com/linkml/linkml) project.
|
4 | 4 | Copier supports code lifecycle management, allowing you to seamlessly incorporate updates into your project when the template is enhanced.
|
5 | 5 |
|
6 |
| -* Starting from 0.2.x we give up compatibility to introduce new features and to re-organise and clean-up the code. |
7 |
| -* Early releases (0.1.x) have maintained backwards compatibility with [linkml-project-cookiecutter](https://github.com/linkml/linkml-project-cookiecutter/). |
8 |
| - This facilitates to experiment with the migration of existing cruft/cookiecutter-based projects. |
9 |
| - Over time the migration may become more difficult as the cookiecutter template evolves. |
| 6 | +* Starting from 0.2.x we give up compatibility with the directory layout from [linkml-project-cookiecutter](https://github.com/linkml/linkml-project-cookiecutter/) that we followed initially. This is required to introduce new features and to realise our idea of a cleaner, easier to update linkml project template. |
| 7 | +* Early releases (0.1.x) are backwards compatibility with [linkml-project-cookiecutter](https://github.com/linkml/linkml-project-cookiecutter/) (same directory layout and commands). |
| 8 | + This facilitates experimenting with the migration of existing cruft/cookiecutter-based projects. |
| 9 | + Over time the migration is expected to become more difficult as the cookiecutter template evolves. We don't plan to maintain compatible releases beyond v0.1.7. |
10 | 10 |
|
11 | 11 | The generated project uses [just](https://github.com/casey/just) as preferred command runner, even in the 0.1.x releases.
|
12 | 12 |
|
@@ -233,3 +233,11 @@ However, sometimes this is impossible and conflicts occur.
|
233 | 233 | They will be inlined into the conflicting files and can be resolved just like any other git conflict.
|
234 | 234 |
|
235 | 235 | For more on updating see copier´s [documentation](https://copier.readthedocs.io/en/stable/updating/).
|
| 236 | + |
| 237 | +### Notes on specific updates |
| 238 | + |
| 239 | +#### From 0.1.x to 0.2.x |
| 240 | + |
| 241 | +The directory layout has changed a lot for 0.2.0. Series 0.1.x had still the directory layout from linkml-project-cookiecutter. Some steps should be done manually: |
| 242 | +- **Before running the update**: Run `just clean` to remove the folder `docs` which was git-ignored in 0.1.x (and linkml-cookiecutter) but will become the main version-managed docs folder in 0.2.x. |
| 243 | +- **After running the update** (before committing): Remove the folder `project/docs` which was also gitignored before v0.2.0 and is of no use for 0.2.0 and later releases. |
0 commit comments