Skip to content

Commit 3f22a2f

Browse files
committed
build: generate attribute docs automatically
1 parent 4873118 commit 3f22a2f

File tree

4 files changed

+279
-98
lines changed

4 files changed

+279
-98
lines changed

README.md

+34-75
Original file line numberDiff line numberDiff line change
@@ -370,105 +370,64 @@ The following attributes are available in `script` fields.
370370

371371
They can be accessed exactly as shown in this list.
372372

373-
#### project
374-
375-
> [!NOTE]
376-
> See the [GitLab GraphQL `Project` GraphQL resource](https://docs.gitlab.com/ee/api/graphql/reference/#project) for more details about the fields.
377-
378-
- `project.archived` (boolean)
379-
- `project.created_at` (time)
380-
- `project.description` (string)
381-
- `project.full_path` (string)
382373
- `project.id` (string)
383-
- `project.last_activity_at` (time)
384-
- `project.name_with_namespace` (string)
385374
- `project.name` (string)
375+
- `project.name_with_namespace` (string)
376+
- `project.description` (string)
386377
- `project.path` (string)
387-
- `project.topics[]` (array of string)
378+
- `project.full_path` (string)
379+
- `project.archived` (bool)
380+
- `project.topics` ([]string)
388381
- `project.visibility` (string)
389-
390-
#### project.labels
391-
392-
> [!NOTE]
393-
> See the [GitLab GraphQL `Label` GraphQL resource](https://docs.gitlab.com/ee/api/graphql/reference/#label) for more details about the fields.
394-
395-
- `project.labels[].color` (string)
396-
- `project.labels[].description` (string)
397382
- `project.labels[].id` (string)
398383
- `project.labels[].title` (string)
399-
400-
#### group
401-
402-
> See the [GitLab GraphQL `Group` GraphQL resource](https://docs.gitlab.com/ee/api/graphql/reference/#group) for more details about the fields.
403-
404-
- `group.description` (string)
384+
- `project.labels[].color` (string)
385+
- `project.labels[].description` (string)
386+
- `project.last_activity_at` (time)
387+
- `project.created_at` (time)
405388
- `group.id` (string)
406389
- `group.name` (string)
407-
408-
#### merge_request
409-
410-
> See the [GitLab GraphQL `MergeRequest` GraphQL resource](https://docs.gitlab.com/ee/api/graphql/reference/#mergerequest) for more details about the fields.
411-
390+
- `group.description` (string)
412391
- `merge_request.approvals_left` (int)
413392
- `merge_request.approvals_required` (int)
414-
- `merge_request.approved` (boolean)
415-
- `merge_request.auto_merge_enabled` (int)
393+
- `merge_request.approved` (bool)
394+
- `merge_request.auto_merge_enabled` (bool)
416395
- `merge_request.auto_merge_strategy` (string)
417396
- `merge_request.conflicts` (bool)
418397
- `merge_request.created_at` (time)
419398
- `merge_request.description` (string)
399+
- `merge_request.diff_stats[].path` (string)
400+
- `merge_request.diff_stats[].additions` (int)
401+
- `merge_request.diff_stats[].deletions` (int)
420402
- `merge_request.diverged_from_target_branch` (bool)
421-
- `merge_request.draft` (boolean)
403+
- `merge_request.draft` (bool)
404+
- `merge_request.first_commit.author_email` (string)
405+
- `merge_request.first_commit.committed_date` (time)
422406
- `merge_request.id` (string)
423407
- `merge_request.iid` (string)
408+
- `merge_request.labels[].id` (string)
409+
- `merge_request.labels[].title` (string)
410+
- `merge_request.labels[].color` (string)
411+
- `merge_request.labels[].description` (string)
412+
- `merge_request.last_commit.author_email` (string)
413+
- `merge_request.last_commit.committed_date` (time)
414+
- `merge_request.mergeable` (bool)
415+
- `merge_request.merged_at` (optional time)
424416
- `merge_request.merge_status_enum` (string)
425-
- `merge_request.mergeable` (boolean)
426-
- `merge_request.merged_at` (optional, time)
427-
- `merge_request.source_branch_exists` (boolean)
428-
- `merge_request.source_branch_protected` (boolean)
429417
- `merge_request.source_branch` (string)
430-
- `merge_request.squash_on_merge` (boolean)
431-
- `merge_request.squash` (boolean)
418+
- `merge_request.source_branch_exists` (bool)
419+
- `merge_request.source_branch_protected` (bool)
420+
- `merge_request.squash` (bool)
421+
- `merge_request.squash_on_merge` (bool)
432422
- `merge_request.state` (string)
433-
- `merge_request.target_branch_exists` (string)
434423
- `merge_request.target_branch` (string)
435-
- `merge_request.time_between_first_and_last_commit` (duration) - SCM Engine - The `duration()` between the first and last commit in the Merge Request.
436-
- `merge_request.time_since_first_commit` (duration) - SCM Engine - The `duration()` between `now()` and the first commit in the Merge Request.
437-
- `merge_request.time_since_last_commit` (duration) - SCM Engine - The `duration()` between `now()` and the last commit in the Merge Request.
424+
- `merge_request.target_branch_exists` (bool)
425+
- `merge_request.time_between_first_and_last_commit` (optional duration)
426+
- `merge_request.time_since_first_commit` (optional duration)
427+
- `merge_request.time_since_last_commit` (optional duration)
438428
- `merge_request.title` (string)
439429
- `merge_request.updated_at` (time)
440430

441-
#### merge_request.diff_stats
442-
443-
> See the [GitLab GraphQL `DiffStats` GraphQL resource](https://docs.gitlab.com/ee/api/graphql/reference/#diffstats) for more details about the fields.
444-
445-
- `merge_request.diff_stats[].additions` (int)
446-
- `merge_request.diff_stats[].deletions` (int)
447-
- `merge_request.diff_stats[].path` (string)
448-
449-
#### merge_request.first_commit
450-
451-
> See the [GitLab GraphQL `Commit` GraphQL resource](https://docs.gitlab.com/ee/api/graphql/reference/#commit) for more details about the fields.
452-
453-
- `merge_request.first_commit.author_email` (string)
454-
- `merge_request.first_commit.committed_date` (string)
455-
456-
#### merge_request.last_commit
457-
458-
> See the [GitLab GraphQL `Commit` GraphQL resource](https://docs.gitlab.com/ee/api/graphql/reference/#commit) for more details about the fields.
459-
460-
- `merge_request.last_commit.author_email` (string)
461-
- `merge_request.last_commit.committed_date` (string)
462-
463-
#### merge_request.labels
464-
465-
> See the [GitLab GraphQL `Label` GraphQL resource](https://docs.gitlab.com/ee/api/graphql/reference/#label) for more details about the fields.
466-
467-
- `merge_request.labels[].color` (string)
468-
- `merge_request.labels[].description` (string)
469-
- `merge_request.labels[].id` (string)
470-
- `merge_request.labels[].title` (string)
471-
472431
### Functions
473432

474433
#### `merge_request.modified_files`

schema/docs.tmpl

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{{- define "attributes" -}}
2+
{{- range .Attributes -}}
3+
{{ if .IsCustomType -}}{{- template "attributes" . }}{{- else }}
4+
- `{{ .BlockName }}` ({{ if .Optional }}optional {{ end }}{{ .Type }}){{- end -}}
5+
{{- end }}
6+
{{- end -}}
7+
8+
### Attributes
9+
{{ template "attributes" . -}}

0 commit comments

Comments
 (0)