Added user interaction diagrams for the release automation

specs/release-automation/release-automation-specs.qmd

@@ -14,6 +14,13 @@ Practically, the dictionary is implemented as an Excel document. Although the ma
 
 Releasing a new version of the dictionary is a laborious process that requires converting the excel document to multiple output formats. In addition, the different release files need to be uploaded to multiple release locations. Details about the release process are available [online](https://odm.discourse.group/t/generation-of-tables-and-lists-from-the-odm-working-excel-file/99/7). The current manual process of implementing a release takes time away from the dictionary developers as well as is susceptible to errors. Automating this process would increase the quality of each release as well as give back time to the dictionary staff.
 
+## User interactions
+
+The user will interact with the software system in two ways:
+
+1. **Trigerring a release**: The user will use the GitHub actions tab to start a new release. The steps are outlined in [this diagram](./trigerring-a-release.puml); and
+2. **Merging a release**: Once the user is happy with the release changes, they can merge their release by merging the release PR. The steps are outlines in [this diagram](./merging-a-release.puml).
+
 ## Software Constraints
 
 * The software system will need to use GitHub actions as its continuous integration tool.

specs/release-automation/user-interaction-diagrams/merging-a-release.puml

@@ -0,0 +1,11 @@
+@startuml Merging a release
+
+start
+
+:User merges the release PR on GitHub to main;
+
+:The release software system uploads the necesarry release files to OSF;
+
+end
+
+@enduml

specs/release-automation/user-interaction-diagrams/trigerring-a-release.puml

@@ -0,0 +1,19 @@
+@startuml Creating a new release
+
+header Trigerring a new release
+
+start
+
+:User copies the new dictionary file into the staging folder on OSF;
+
+:User copies the OSF link for the new dictionary file;
+
+:User triggers a release build on GitHub, providing the copied OSF dictionary
+link and their OSF personal access token;
+
+:The release software system creates a PR to main that contains all the
+release files generated from the linked ODM dictionary file;
+
+end
+
+@enduml