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: README.md
+28-13Lines changed: 28 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ This template uses the code-scaffolding tool [copier](https://copier.readthedocs
4
4
Copier supports code lifecycle management, allowing you to seamlessly incorporate updates into your project when the template is enhanced.
5
5
6
6
* Early releases (0.1.x) maintain backwards compatibility with [linkml-project-cookiecutter](https://github.com/linkml/linkml-project-cookiecutter/). This facilitates to experiment with the migration of existing cruft/cookiecutter-based projects.
7
-
*Later releases starting with 0.2.0 will gradually give up compatibility.
7
+
*Starting from 0.2.x we give up compatibility to introduce new features and to re-organise and clean-up the code. The migration from 0.1.x to 0.2.x is not too difficult but requires some manual work.
8
8
9
9
The generated project uses [just](https://github.com/casey/just) as preferred command runner, even in the 0.1.x releases.
10
10
@@ -151,9 +151,12 @@ just testdoc
151
151
3. Configure your repository for deploying the documentation as GitHub pages
152
152
153
153
* Under Settings > Actions > General in section "Workflow Permissions" mark "Read repository and packages permission".
154
-
* Under Pages in section "Build and Deployment":
155
-
* Under "Source" select "Deploy from a branch"
156
-
* Under "Branch" select "gh-pages" and "/ (root)"
154
+
* Go to "Actions" tab, select on the left under Actions "Deploy docs", and click the "Run workflow" button on the right.
155
+
Run from main-branch as suggested and verify successful completion.
156
+
* Now go back to Settings > Pages. In section "Build and Deployment" select
157
+
* Under "Source": "Deploy from a branch"
158
+
* Under "Branch": "gh-pages" and "/ (root)"
159
+
* Hint: The "gh-pages" branch is created automatically in the first successful run of the "deploy docs" workflow.
157
160
158
161
### Step 7: Register the schema
159
162
@@ -176,16 +179,24 @@ The commands are written to be run at the root of your project.
176
179
git switch -c migrate-to-copier
177
180
```
178
181
179
-
180
-
* Adapt your project and create a copier answers file (`.copier-answers`) by running:
182
+
* Adapt your project and create a copier answers file (`.copier-answers`) by running (this updates to the latest released version):
0 commit comments