Skip to content

Commit 554e8a9

Browse files
committed
adding images to storyline
1 parent ad6dbf5 commit 554e8a9

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

docs/Repository_Structure_and_automations/New_Data_Workflow.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ On submission, the pre-allocated labels are appended:
9393
9494
<image src='/assets/demo_images/issues_created.png'/>
9595
96-
and the form content saved in its body.
96+
and the form content saved as the main issue.
9797
9898
<image src='/assets/demo_images/issue_submission.png'/>
9999
@@ -110,6 +110,9 @@ on:
110110
issues:
111111
types: [opened, edited]
112112
```
113+
114+
This means that should a submission need to be edited, the checks will run again until the relevant sections pass or the issue is closed.
115+
113116
#### permissions
114117
For workflows which need to interact with the repository, we need to define what the action is allowed to do. In this case, we can change the issue, repository content and create a pull request.
115118
```yaml
@@ -163,7 +166,7 @@ We then checkout the repository, and run a set of python scripts. As the python
163166
new_issue
164167
```
165168

166-
## CMIPLD command line scripts.
169+
### CMIPLD command line scripts.
167170
When installing a python package, we are able to define entry-points. These are python functions which can be run as command line scripts. For example the `new_issue` command executes the `main` function from [`cmipld.generate.new_issue`](https://github.com/WCRP-CMIP/CMIP-LD/blob/main/cmipld/generate/new_issue.py).
168171

169172
This starts by parsing the issue content:
@@ -188,7 +191,7 @@ module.run(parsed_issue,issue)
188191
```
189192

190193

191-
## Issue specific script: Processing
194+
### Issue specific script: Processing
192195
The scripts for each issue will be placed in the `.github/ISSUE_SCRIPT/` directory and will have the same name as the issue_type (see above).
193196

194197

@@ -248,7 +251,7 @@ def run(issue, packet):
248251
The pull request is also linked to the issue, allowing it to be closed on merge.
249252
<image src='/assets/demo_images/action_pull.png'/>
250253

251-
## Action output.
254+
### Action output.
252255
It is possible to view the status of the action under the actions tab in GitHub. Here we can select the relevant action, view what has been run, and the console output from this (should an error occur).
253256

254257
Additionally when opening a specific action, the action summary has been updated to provide an update of what has been done. An example of this can be seen below.

0 commit comments

Comments
 (0)