Skip to content

Commit 463fd47

Browse files
geoffroy-noel-ddhgeoffroy-noel-ddh
committed
doc: moved the growing editorial workflow instructions to a separate md file; git deploy workflow will ignore those
1 parent f05e535 commit 463fd47

3 files changed

Lines changed: 81 additions & 76 deletions

File tree

‎.github/workflows/frontend.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ on:
1010
- 'codemeta.json'
1111
- 'CITATION.cff'
1212
- 'CHANGELOG.md'
13+
- 'docs/**'
1314
workflow_dispatch:
1415

1516
jobs:

‎README.md‎

Lines changed: 3 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -93,82 +93,9 @@ You can also run tests for specific workspaces from the root:
9393
- `npm run test:frontend` — Run all frontend tests (unit + integration)
9494
- `npm run test:integration` — Run Playwright frontend integration/accessibility tests only
9595

96-
## Adding content to the site
97-
98-
See the [frontend README](frontend/README.md#adding-content) for instructions on
99-
how to add static pages to the site via markdown files.
100-
101-
## Editorial and release workflow
102-
103-
Changes to the content or code should normally happen on the `develop` branch.
104-
Any commit on that branch will automatically trigger a release
105-
to the **[staging/preview site](https://kingsdigitallab.github.io/corpus-building/)**.
106-
107-
Once the changes accumulated on the staging site are ready for public release
108-
they can be merged dierectly into the `main` branch by a developer.
109-
Alternatively non-developers can create
110-
[a new Pull Request](https://github.com/kingsdigitallab/corpus-building/compare/main...develop)
111-
to be reviewed and merged by someone else.
112-
113-
Any update of the `main` branch will automatically trigger a release
114-
via SSH to the **[public/live/production site](https://sicily.classics.ox.ac.uk/)**
115-
hosted on Oxford server.
116-
117-
### Automated release process
118-
119-
In both cases
120-
[the automated release process](https://github.com/kingsdigitallab/corpus-building/blob/main/.github/workflows/frontend.yml)
121-
from a modified branch first does the following:
122-
1. fetches the latest version of the TEI corpus from https://github.com/ISicily/ISicily
123-
2. run the ETL process from that corpus to rebuild the site metadata and indices
124-
3. run some automated tests and stops the release if any fails
125-
4. commit the updated metadata and indices to the branch
126-
127-
The release process may take up to 30 minutes to complete.
128-
[Current and past release workflows are visible on the Actions tab](https://github.com/kingsdigitallab/corpus-building/actions)
129-
of the repository.
130-
There can be a slight delay between the end of the action
131-
and the actual refresh of the content on the target site.
132-
Also note that [hard-refresh in your browser](https://www.wikihow.com/Force-Refresh-in-Your-Internet-Browser)
133-
may be needed to flush old, cached content.
134-
135-
### Hot fixes
136-
137-
Small **[hot fixes](https://en.wikipedia.org/wiki/Hotfix)**
138-
to the code or content of the live site can be done
139-
with a Pull Request directly on the `main` branch.
140-
In that situation extra care should be taken when verifying the changes.
141-
142-
### Changes to the corpus
143-
144-
Although the automated release process pulls [the latest version
145-
of the TEI corpus from the `main` branch of the ISicily repository](https://github.com/ISicily/ISicily/tree/master/inscriptions),
146-
only changes in the code of this repository will trigger the process.
147-
148-
If you only want to update the metadata about the TEI corpus on a site
149-
(staging or production) then you can manually trigger the release process
150-
by following those steps:
151-
1. go to the [Build and deploy workflow](https://github.com/kingsdigitallab/corpus-building/actions/workflows/frontend.yml) on the Corpus Building repository;
152-
2. click the "Run workflow" dropdown on the right,, just above the table;
153-
3. select the relevant branch (`main` for live site, `develop` for staging site);
154-
4. confirm by clicking the "Run workflow" button
155-
156-
<img width="932" height="544" alt="Screenshot_20260805_121747" src="https://github.com/user-attachments/assets/221f1737-18c7-40c0-8ab0-d2ef80a112ba" />
157-
158-
You should be redirected to a new page for that release job
159-
where you can see its running status in real time.
160-
You'll notice a "Cancel workflow" button in the top right corner
161-
to interrupt the job. You can't resume a cancelled job;
162-
instead you would run a new one.
163-
164-
<img width="1139" height="736" alt="Screenshot_20260805_121201" src="https://github.com/user-attachments/assets/153dcc5e-3b27-4399-8f2a-25ba2d3e3555" />
165-
166-
You can also see all the current and past jobs on the Build and deploy page.
167-
The color of the icon in fron of each row indicates the status of the job:
168-
animated orange is curently running; blue tick was successful;
169-
red cross failed; and greyed was cancelled.
170-
171-
<img width="932" height="757" alt="Screenshot_20260805_121318" src="https://github.com/user-attachments/assets/d4ca61e3-2814-4647-b20d-72f907de5b22" />
96+
## Editorial and Release Workflows
97+
98+
More information about [Editorial and Release Workflows](docs/editorial-and-release-workflows.md).
17299

173100
## How to cite
174101

‎docs/editorial-and-release-workflows.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
## Adding content to the site
2+
3+
See the [frontend README](../frontend/README.md#adding-content)
4+
for instructions on how to add static pages to the site via markdown files.
5+
6+
## Editorial and release workflow
7+
8+
Changes to the content or code should normally happen on the `develop` branch.
9+
Any commit on that branch will automatically trigger a release
10+
to the **[staging/preview site](https://kingsdigitallab.github.io/corpus-building/)**.
11+
12+
Once the changes accumulated on the staging site are ready for public release
13+
they can be merged dierectly into the `main` branch by a developer.
14+
Alternatively non-developers can create
15+
[a new Pull Request](https://github.com/kingsdigitallab/corpus-building/compare/main...develop)
16+
to be reviewed and merged by someone else.
17+
18+
Any update of the `main` branch will automatically trigger a release
19+
via SSH to the **[public/live/production site](https://sicily.classics.ox.ac.uk/)**
20+
hosted on Oxford server.
21+
22+
### Automated release process
23+
24+
In both cases
25+
[the automated release process](https://github.com/kingsdigitallab/corpus-building/blob/main/.github/workflows/frontend.yml)
26+
from a modified branch first does the following:
27+
1. fetches the latest version of the TEI corpus from https://github.com/ISicily/ISicily
28+
2. run the ETL process from that corpus to rebuild the site metadata and indices
29+
3. run some automated tests and stops the release if any fails
30+
4. commit the updated metadata and indices to the branch
31+
32+
The release process may take up to 30 minutes to complete.
33+
[Current and past release workflows are visible on the Actions tab](https://github.com/kingsdigitallab/corpus-building/actions)
34+
of the repository.
35+
There can be a slight delay between the end of the action
36+
and the actual refresh of the content on the target site.
37+
Also note that [hard-refresh in your browser](https://www.wikihow.com/Force-Refresh-in-Your-Internet-Browser)
38+
may be needed to flush old, cached content.
39+
40+
### Hot fixes
41+
42+
Small **[hot fixes](https://en.wikipedia.org/wiki/Hotfix)**
43+
to the code or content of the live site can be done
44+
with a Pull Request directly on the `main` branch.
45+
In that situation extra care should be taken when verifying the changes.
46+
47+
### Changes to the corpus
48+
49+
Although the automated release process pulls [the latest version
50+
of the TEI corpus from the `main` branch of the ISicily repository](https://github.com/ISicily/ISicily/tree/master/inscriptions),
51+
only changes in the code of this repository will trigger the process.
52+
53+
If you only want to update the metadata about the TEI corpus on a site
54+
(staging or production) then you can manually trigger the release process
55+
by following those steps:
56+
1. go to the [Build and deploy workflow](https://github.com/kingsdigitallab/corpus-building/actions/workflows/frontend.yml) on the Corpus Building repository;
57+
2. click the "Run workflow" dropdown on the right,, just above the table;
58+
3. select the relevant branch (`main` for live site, `develop` for staging site);
59+
4. confirm by clicking the "Run workflow" button
60+
61+
<img width="932" height="544" alt="Screenshot_20260805_121747" src="https://github.com/user-attachments/assets/221f1737-18c7-40c0-8ab0-d2ef80a112ba" />
62+
63+
You should be redirected to a new page for that release job
64+
where you can see its running status in real time.
65+
You'll notice a "Cancel workflow" button in the top right corner
66+
to interrupt the job. You can't resume a cancelled job;
67+
instead you would run a new one.
68+
69+
<img width="1139" height="736" alt="Screenshot_20260805_121201" src="https://github.com/user-attachments/assets/153dcc5e-3b27-4399-8f2a-25ba2d3e3555" />
70+
71+
You can also see all the current and past jobs on the
72+
[Build and deploy workflow](https://github.com/kingsdigitallab/corpus-building/actions/workflows/frontend.yml) page.
73+
The color of the icon in fron of each row indicates the status of the job:
74+
animated orange is curently running; blue tick was successful;
75+
red cross failed; and greyed was cancelled.
76+
77+
<img width="932" height="757" alt="Screenshot_20260805_121318" src="https://github.com/user-attachments/assets/d4ca61e3-2814-4647-b20d-72f907de5b22" />

0 commit comments

Comments
 (0)