debian-mirror-gitlab/doc/api/templates/gitignores.md

153 lines
3.9 KiB
Markdown
Raw Normal View History

2019-12-04 20:38:33 +05:30
---
2021-01-29 00:20:46 +05:30
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/#designated-technical-writers
2019-12-04 20:38:33 +05:30
type: reference
---
2020-10-24 23:57:45 +05:30
# .gitignore API
2019-12-04 20:38:33 +05:30
In GitLab, there is an API endpoint available for `.gitignore`. For more
information on `gitignore`, see the
[Git documentation](https://git-scm.com/docs/gitignore).
2016-11-03 12:29:30 +05:30
2019-07-07 11:18:12 +05:30
## List `.gitignore` templates
2016-11-03 12:29:30 +05:30
2019-07-07 11:18:12 +05:30
Get all `.gitignore` templates.
2016-11-03 12:29:30 +05:30
2019-12-21 20:55:43 +05:30
```plaintext
2016-11-03 12:29:30 +05:30
GET /templates/gitignores
```
2019-12-21 20:55:43 +05:30
Example request:
2020-03-13 15:44:24 +05:30
```shell
2017-08-17 22:00:37 +05:30
curl https://gitlab.example.com/api/v4/templates/gitignores
2016-11-03 12:29:30 +05:30
```
Example response:
```json
[
{
2018-12-05 23:21:45 +05:30
"key": "Actionscript",
"name": "Actionscript"
2016-11-03 12:29:30 +05:30
},
{
2018-12-05 23:21:45 +05:30
"key": "Ada",
2016-11-03 12:29:30 +05:30
"name": "Ada"
},
{
2018-12-05 23:21:45 +05:30
"key": "Agda",
"name": "Agda"
2016-11-03 12:29:30 +05:30
},
{
2018-12-05 23:21:45 +05:30
"key": "Android",
2016-11-03 12:29:30 +05:30
"name": "Android"
},
{
2018-12-05 23:21:45 +05:30
"key": "AppEngine",
"name": "AppEngine"
2016-11-03 12:29:30 +05:30
},
{
2018-12-05 23:21:45 +05:30
"key": "AppceleratorTitanium",
"name": "AppceleratorTitanium"
2016-11-03 12:29:30 +05:30
},
{
2018-12-05 23:21:45 +05:30
"key": "ArchLinuxPackages",
2016-11-03 12:29:30 +05:30
"name": "ArchLinuxPackages"
},
{
2018-12-05 23:21:45 +05:30
"key": "Autotools",
2016-11-03 12:29:30 +05:30
"name": "Autotools"
},
{
2018-12-05 23:21:45 +05:30
"key": "C",
"name": "C"
2016-11-03 12:29:30 +05:30
},
{
2018-12-05 23:21:45 +05:30
"key": "C++",
"name": "C++"
2016-11-03 12:29:30 +05:30
},
{
2018-12-05 23:21:45 +05:30
"key": "CFWheels",
2016-11-03 12:29:30 +05:30
"name": "CFWheels"
},
{
2018-12-05 23:21:45 +05:30
"key": "CMake",
2016-11-03 12:29:30 +05:30
"name": "CMake"
},
{
2018-12-05 23:21:45 +05:30
"key": "CUDA",
"name": "CUDA"
2016-11-03 12:29:30 +05:30
},
{
2018-12-05 23:21:45 +05:30
"key": "CakePHP",
"name": "CakePHP"
2016-11-03 12:29:30 +05:30
},
{
2018-12-05 23:21:45 +05:30
"key": "ChefCookbook",
"name": "ChefCookbook"
2016-11-03 12:29:30 +05:30
},
{
2018-12-05 23:21:45 +05:30
"key": "Clojure",
2016-11-03 12:29:30 +05:30
"name": "Clojure"
},
{
2018-12-05 23:21:45 +05:30
"key": "CodeIgniter",
"name": "CodeIgniter"
2016-11-03 12:29:30 +05:30
},
{
2018-12-05 23:21:45 +05:30
"key": "CommonLisp",
"name": "CommonLisp"
2016-11-03 12:29:30 +05:30
},
{
2018-12-05 23:21:45 +05:30
"key": "Composer",
"name": "Composer"
2016-11-03 12:29:30 +05:30
},
{
2018-12-05 23:21:45 +05:30
"key": "Concrete5",
"name": "Concrete5"
2016-11-03 12:29:30 +05:30
}
]
```
2019-07-07 11:18:12 +05:30
## Single `.gitignore` template
2016-11-03 12:29:30 +05:30
2019-07-07 11:18:12 +05:30
Get a single `.gitignore` template.
2016-11-03 12:29:30 +05:30
2019-12-21 20:55:43 +05:30
```plaintext
2016-11-03 12:29:30 +05:30
GET /templates/gitignores/:key
```
2019-12-21 20:55:43 +05:30
| Attribute | Type | Required | Description |
| ---------- | ------ | -------- | ------------------------------------ |
2019-07-07 11:18:12 +05:30
| `key` | string | yes | The key of the `.gitignore` template |
2016-11-03 12:29:30 +05:30
2019-12-21 20:55:43 +05:30
Example request:
2020-03-13 15:44:24 +05:30
```shell
2017-08-17 22:00:37 +05:30
curl https://gitlab.example.com/api/v4/templates/gitignores/Ruby
2016-11-03 12:29:30 +05:30
```
Example response:
```json
{
"name": "Ruby",
"content": "*.gem\n*.rbc\n/.config\n/coverage/\n/InstalledFiles\n/pkg/\n/spec/reports/\n/spec/examples.txt\n/test/tmp/\n/test/version_tmp/\n/tmp/\n\n# Used by dotenv library to load environment variables.\n# .env\n\n## Specific to RubyMotion:\n.dat*\n.repl_history\nbuild/\n*.bridgesupport\nbuild-iPhoneOS/\nbuild-iPhoneSimulator/\n\n## Specific to RubyMotion (use of CocoaPods):\n#\n# We recommend against adding the Pods directory to your .gitignore. However\n# you should judge for yourself, the pros and cons are mentioned at:\n# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control\n#\n# vendor/Pods/\n\n## Documentation cache and generated files:\n/.yardoc/\n/_yardoc/\n/doc/\n/rdoc/\n\n## Environment normalization:\n/.bundle/\n/vendor/bundle\n/lib/bundler/man/\n\n# for a library or gem, you might want to ignore these files since the code is\n# intended to run in multiple environments; otherwise, check them in:\n# Gemfile.lock\n# .ruby-version\n# .ruby-gemset\n\n# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:\n.rvmrc\n"
}
```
2019-12-04 20:38:33 +05:30
<!-- ## Troubleshooting
Include any troubleshooting steps that you can foresee. If you know beforehand what issues
one might have when setting this up, or when something is changed, or on upgrading, it's
important to describe those, too. Think of things that may go wrong and include them here.
This is important to minimize requests for support, and to avoid doc comments with
questions that you know someone might ask.
Each scenario can be a third-level heading, e.g. `### Getting error message X`.
If you have none to add when creating a doc, leave this section in place
but commented out to help encourage others to add to it in the future. -->