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: docs/Repository_Structure_and_automations/New_Data_Workflow.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,10 +12,10 @@ There are two planned routes for entering the required data:
12
12
### GitHub form
13
13
Github issue templates can be used to guide input in the form of markdown files. More recently the option to use a yml file to create a form has been added. Using this we define an input form with relevant descriptions which once filled creates a formatted issue.
14
14
15
-
For more information on the syntax (click here)[https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema]
15
+
For more information on the syntax [click here](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema)
16
16
17
17
#### Where are the issue forms?
18
-
Issue forms reside in the `.workflows/ISSUE_TEMPLATE/` directory. Here we explore the structure of the (`add_institution.yml`)[https://github.com/WCRP-CMIP/WCRP-universe/blob/Institution_UCLA/.github/ISSUE_TEMPLATE/add_institution.yml] template. The structure of this is described below:
18
+
Issue forms reside in the `.workflows/ISSUE_TEMPLATE/` directory. Here we explore the structure of the [`add_institution.yml`](https://github.com/WCRP-CMIP/WCRP-universe/blob/Institution_UCLA/.github/ISSUE_TEMPLATE/add_institution.yml) template. The structure of this is described below:
19
19
20
20
##### Issue Labels
21
21
Exploring the source code we can assign automatic labels for when the issue is created:
@@ -96,7 +96,7 @@ On submission, the pre-allocated labels are appended.
96
96
97
97
## Workflow
98
98
99
-
When an issue is created or changed, we want to be able to run a series of scripts. These are called workflows. A workflow is defined in `.github/workflows`, with the components of the issue specific workflow (new_issue.yml)[https://github.com/WCRP-CMIP/WCRP-universe/blob/Institution_UCLA/.github/workflows/new_issue.yml] being outlined below.
99
+
When an issue is created or changed, we want to be able to run a series of scripts. These are called workflows. A workflow is defined in `.github/workflows`, with the components of the issue specific workflow [new_issue.yml](https://github.com/WCRP-CMIP/WCRP-universe/blob/Institution_UCLA/.github/workflows/new_issue.yml) being outlined below.
100
100
101
101
### Workflow content
102
102
@@ -130,7 +130,7 @@ Instead of duplicating the same processing scripts in every repository we make u
130
130
131
131
### Reusable Actions.
132
132
133
-
The reusable action is located as part of the (CMIP-LD repository)[https://github.com/WCRP-CMIP/CMIP-LD/blob/main/actions/new-issue/action.yml].
133
+
The reusable action is located as part of the [CMIP-LD repository](https://github.com/WCRP-CMIP/CMIP-LD/blob/main/actions/new-issue/action.yml).
134
134
135
135
Here the action begins by installing the cmipld python library
136
136
```yaml
@@ -161,7 +161,7 @@ We then checkout the repository, and run a set of python scripts. As the python
161
161
```
162
162
163
163
## CMIPLD command line scripts.
164
-
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].
164
+
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).
0 commit comments