Skip to content

Commit 0d61243

Browse files
doc: added instructions for manual site release to README.md
1 parent a0a37d3 commit 0d61243

1 file changed

Lines changed: 45 additions & 6 deletions

File tree

README.md

Lines changed: 45 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -101,16 +101,27 @@ how to add static pages to the site via markdown files.
101101
## Editorial and release workflow
102102

103103
Changes to the content or code should normally happen on the `develop` branch.
104-
Any commit on that branch will automatically trigger a release to the **[staging/preview site](https://kingsdigitallab.github.io/corpus-building/)**.
104+
Any commit on that branch will automatically trigger a release
105+
to the **[staging/preview site](https://kingsdigitallab.github.io/corpus-building/)**.
105106

106107
Once the changes accumulated on the staging site are ready for public release
107-
they can be merged into the `main` branch by a developer or with [a new Pull Request](https://github.com/kingsdigitallab/corpus-building/compare/main...develop).
108-
Any update of that branch will automatically trigger a release to the Oxford **[public/live/production site](https://sicily.classics.ox.ac.uk/)** via SSH.
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.
109112

110-
In both cases [the automated release process](https://github.com/kingsdigitallab/corpus-building/blob/main/.github/workflows/frontend.yml) from a modified branch first does the following:
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:
111122
1. fetches the latest version of the TEI corpus from https://github.com/ISicily/ISicily
112123
2. run the ETL process from that corpus to rebuild the site metadata and indices
113-
3. run some automated tests and stops the release if they fail
124+
3. run some automated tests and stops the release if any fails
114125
4. commit the updated metadata and indices to the branch
115126

116127
The release process may take up to 30 minutes to complete.
@@ -121,10 +132,38 @@ and the actual refresh of the content on the target site.
121132
Also note that [hard-refresh in your browser](https://www.wikihow.com/Force-Refresh-in-Your-Internet-Browser)
122133
may be needed to flush old, cached content.
123134

124-
Small **hot fixes** to the code or content of the live site can be done
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
125139
with a Pull Request directly on the `main` branch.
126140
In that situation extra care should be taken when verifying the changes.
127141

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+
You should be redirected to a new page for that release job
157+
where you can see its running status in real time.
158+
You'll notice a "Cancel workflow" button in the top right corner
159+
to interrupt the job. You can't resume a cancelled job;
160+
instead you would run a new one.
161+
162+
You can also see all the current and past jobs on the Build and deploy page.
163+
The color of the icon in fron of each row indicates the status of the job:
164+
animated orange is curently running; blue tick was successful;
165+
red cross failed; and greyed was cancelled.
166+
128167
## How to cite
129168

130169
```bibtex

0 commit comments

Comments
 (0)