Welcome to mirror list, hosted at ThFree Co, Russian Federation.

csv_export.md « issues « project « user « doc - gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: e5d698fa97a925c669a233799eb9ac4f16abc08c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
---
stage: none
group: unassigned
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---

# Export issues to CSV **(FREE)**

> Moved to GitLab Free in 12.10.

You can export issues as CSV files from GitLab, which are sent to your default
notification email address as an attachment.

**Export Issues to CSV** enables you and your team to export all the data
collected from issues into a **[comma-separated values](https://en.wikipedia.org/wiki/Comma-separated_values)** (CSV)
file, which stores tabular data in plain text.

> _CSVs are a handy way of getting data from one program to another where one
program cannot read the other ones normal output._ [Ref](https://www.quora.com/What-is-a-CSV-file-and-its-uses)

<!-- vale gitlab.Spelling = NO -->

CSV files can be used with any plotter or spreadsheet-based program, such as
Microsoft Excel, Open Office Calc, or Google Sheets.

<!-- vale gitlab.Spelling = YES -->

Here are some of the uses of exporting issues as CSV files:

- Make a snapshot of issues for offline analysis or to communicate with other
  teams who may not be in GitLab.
- Create diagrams, graphs, and charts from the CSV data.
- Present the data in any other format for auditing or sharing reasons.
- Import the issues elsewhere to a system outside of GitLab.
- Long-term issues' data analysis with multiple snapshots created along the
  time.
- Use the long-term data to gather relevant feedback given in the issues, and
  improve your product based on real metrics.

## Choosing which issues to include

After selecting a project, from the issues page you can narrow down which
issues to export using the search bar, along with the All/Open/Closed tabs. All
issues returned are exported, including those not shown on the first page.

![CSV export button](img/csv_export_button_v12_9.png)

GitLab asks you to confirm the number of issues and email address for the
export, after which the email is prepared.

![CSV export modal dialog](img/csv_export_modal.png)

## Sorting

Exported issues are always sorted by `Title`.

## Format

Data is encoded with a comma as the column delimiter, with `"` used to quote
fields if needed, and newlines to separate rows. The first row contains the
headers, which are listed in the following table along with a description of
the values:

| Column                                   | Description                                               |
|------------------------------------------|-----------------------------------------------------------|
| Title                                    | Issue `title`                                             |
| Description                              | Issue `description`                                       |
| Issue ID                                 | Issue `iid`                                               |
| URL                                      | A link to the issue on GitLab                             |
| State                                    | `Open` or `Closed`                                        |
| Author                                   | Full name of the issue author                             |
| Author Username                          | Username of the author, with the `@` symbol omitted       |
| Assignee                                 | Full name of the issue assignee                           |
| Assignee Username                        | Username of the author, with the `@` symbol omitted       |
| Confidential                             | `Yes` or `No`                                             |
| Locked                                   | `Yes` or `No`                                             |
| Due Date                                 | Formatted as `YYYY-MM-DD`                                 |
| Created At (UTC)                         | Formatted as `YYYY-MM-DD HH:MM:SS`                        |
| Updated At (UTC)                         | Formatted as `YYYY-MM-DD HH:MM:SS`                        |
| Milestone                                | Title of the issue milestone                              |
| Weight                                   | Issue weight                                              |
| Labels                                   | Title of any labels joined with a `,`                     |
| Time Estimate                            | [Time estimate](../time_tracking.md#estimates) in seconds |
| Time Spent                               | [Time spent](../time_tracking.md#time-spent) in seconds   |
| [Epic](../../group/epics/index.md) ID    | ID of the parent epic, introduced in 12.7                 |
| [Epic](../../group/epics/index.md) Title | Title of the parent epic, introduced in 12.7              |

In GitLab 14.7 and earlier, the first two columns were `Issue ID` and `URL`,
which [caused an issue](https://gitlab.com/gitlab-org/gitlab/-/issues/34769)
when importing back into GitLab.

## Limitations

- Export Issues to CSV is not available at the Group's Issues List.
- Issues are sent as an email attachment, with a 15 MB export limit to ensure
  successful delivery across a range of email providers. If you reach the limit,
  we suggest narrowing the search before export, perhaps by exporting open and
  closed issues separately.
- CSV files are plain text files. This means that the exported CSV file doesn't
  contain any issue attachments.