debian-mirror-gitlab/doc/user/project/issues/csv_export.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

101 lines
5.4 KiB
Markdown
Raw Normal View History

2021-01-29 00:20:46 +05:30
---
stage: none
group: unassigned
2022-11-25 23:54:43 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2021-01-29 00:20:46 +05:30
---
2021-09-04 01:27:46 +05:30
# Export issues to CSV **(FREE)**
2019-07-31 22:56:46 +05:30
2021-03-11 19:13:27 +05:30
> Moved to GitLab Free in 12.10.
2019-07-31 22:56:46 +05:30
2021-09-04 01:27:46 +05:30
You can export issues as CSV files from GitLab, which are sent to your default
notification email address as an attachment.
2019-07-31 22:56:46 +05:30
2021-09-04 01:27:46 +05:30
**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.
2019-07-31 22:56:46 +05:30
2022-11-25 23:54:43 +05:30
> _CSVs are a way of getting data from one program to another where one
2021-09-04 01:27:46 +05:30
program cannot read the other ones normal output._ [Ref](https://www.quora.com/What-is-a-CSV-file-and-its-uses)
2019-07-31 22:56:46 +05:30
2021-10-27 15:23:28 +05:30
<!-- vale gitlab.Spelling = NO -->
2021-09-04 01:27:46 +05:30
CSV files can be used with any plotter or spreadsheet-based program, such as
2021-10-27 15:23:28 +05:30
Microsoft Excel, Open Office Calc, or Google Sheets.
<!-- vale gitlab.Spelling = YES -->
2019-07-31 22:56:46 +05:30
2021-09-04 01:27:46 +05:30
Here are some of the uses of exporting issues as CSV files:
2019-07-31 22:56:46 +05:30
2021-09-04 01:27:46 +05:30
- 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.
2019-07-31 22:56:46 +05:30
## Choosing which issues to include
2021-09-04 01:27:46 +05:30
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.
2019-07-31 22:56:46 +05:30
2020-04-22 19:07:51 +05:30
![CSV export button](img/csv_export_button_v12_9.png)
2019-07-31 22:56:46 +05:30
2021-09-04 01:27:46 +05:30
GitLab asks you to confirm the number of issues and email address for the
export, after which the email is prepared.
2019-07-31 22:56:46 +05:30
![CSV export modal dialog](img/csv_export_modal.png)
## Sorting
2022-05-07 20:08:51 +05:30
Exported issues are always sorted by `Title`.
2019-07-31 22:56:46 +05:30
## Format
2021-09-04 01:27:46 +05:30
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:
2022-04-04 11:22:00 +05:30
| Column | Description |
|------------------------------------------|-----------------------------------------------------------|
2022-05-07 20:08:51 +05:30
| Title | Issue `title` |
| Description | Issue `description` |
2022-04-04 11:22:00 +05:30
| 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 |
2019-07-31 22:56:46 +05:30
2022-05-07 20:08:51 +05:30
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.
2019-07-31 22:56:46 +05:30
## Limitations
2019-12-21 20:55:43 +05:30
- Export Issues to CSV is not available at the Group's Issues List.
2021-09-04 01:27:46 +05:30
- 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.