README.md 3.71 KB
Newer Older
1
# GitLab Runner
Kamil Trzciński's avatar
Kamil Trzciński committed
2

Sid Sijbrandij's avatar
Sid Sijbrandij committed
3 4
This is the repository of the official GitLab Runner written in Go.
It runs tests and sends the results to GitLab.
5
[GitLab CI](https://about.gitlab.com/gitlab-ci) is the open-source
Sid Sijbrandij's avatar
Sid Sijbrandij committed
6
continuous integration service included with GitLab that coordinates the testing.
Sid Sijbrandij's avatar
Sid Sijbrandij committed
7
The old name of this project was GitLab CI Multi Runner but please use "GitLab Runner" (without CI) from now on.
Kamil Trzciński's avatar
Kamil Trzciński committed
8

9
![Build Status](https://gitlab.com/gitlab-org/gitlab-runner/badges/master/build.svg)
10

11 12
## Runner and GitLab CE/EE compatibility

13
For a list of compatible versions between GitLab and GitLab Runner, consult
14
the [compatibility section](https://docs.gitlab.com/runner/#compatibility-with-gitlab-versions).
15

16
## Release process
17 18 19

The description of release process of GitLab Runner project can be found in the [release documentation](docs/release_process/README.md).

20
## Contributing
21

22
Contributions are welcome, see [`CONTRIBUTING.md`](CONTRIBUTING.md) for more details.
23

24
### Closing issues and merge requests
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41

GitLab is growing very fast and we have a limited resources to deal with reported issues
and merge requests opened by the community volunteers. We appreciate all the contributions
coming from our community. But to help all of us with issues and merge requests management
we need to create some closing policy.

If an issue or merge request has a ~"waiting for feedback" label and the response from the
reporter has not been received for 14 days, we can close it using the following response
template:

```
We haven't received an update for more than 14 days so we will assume that the
problem is fixed or is no longer valid. If you still experience the same problem
try upgrading to the latest version. If the issue persists, reopen this issue
or merge request with the relevant information.
```

42 43 44 45 46
### Contributing to documentation

If your contribution contains only documentation changes, you can speed up the CI process
by following some branch naming conventions, as described in https://docs.gitlab.com/ce/development/documentation/index.html#branch-naming

47
## Documentation
48

49 50
The documentation source files can be found under the [docs/](docs/) directory. You can
read the documentation online at https://docs.gitlab.com/runner/.
51

52
## Requirements
53

54
[Read about the requirements of GitLab Runner.](https://docs.gitlab.com/runner/#requirements)
55

56
## Features
57

58
[Read about the features of GitLab Runner.](https://docs.gitlab.com/runner/#features)
59

60
## Executors compatibility chart
61

62
[Read about what options each executor can offer.](https://docs.gitlab.com/runner/executors/#compatibility-chart)
63

64
## Install GitLab Runner
65

66
Visit the [installation documentation](https://docs.gitlab.com/runner/install/).
67

68
## Use GitLab Runner
69

70
See [https://docs.gitlab.com/runner/#using-gitlab-runner](https://docs.gitlab.com/runner/#using-gitlab-runner).
71

72
## Select executor
73

74
See [https://docs.gitlab.com/runner/executors/#selecting-the-executor](https://docs.gitlab.com/runner/executors/#selecting-the-executor).
75

76
## Troubleshooting
77

78
Read the [FAQ](https://docs.gitlab.com/runner/faq/).
79

80
## Advanced Configuration
81

82
See [https://docs.gitlab.com/runner/#advanced-configuration](https://docs.gitlab.com/runner/#advanced-configuration).
83

84
## Building and development
85 86 87

See [https://docs.gitlab.com/runner/development/](https://docs.gitlab.com/runner/development/).

88
## Changelog
Kamil Trzciński's avatar
Kamil Trzciński committed
89

90
Visit the [Changelog](CHANGELOG.md) to view recent changes.
Kamil Trzciński's avatar
Kamil Trzciński committed
91

92
## The future
Kamil Trzciński's avatar
Kamil Trzciński committed
93

Sid Sijbrandij's avatar
Sid Sijbrandij committed
94 95
* Please see the [GitLab Direction page](https://about.gitlab.com/direction/).
* Feel free submit issues with feature proposals on the issue tracker.
Kamil Trzciński's avatar
Kamil Trzciński committed
96

97
## Author
Kamil Trzciński's avatar
Kamil Trzciński committed
98

99 100
- 2014 - 2015   : [Kamil Trzciński](mailto:ayufan@ayufan.eu)
- 2015 - now    : GitLab Inc. team and contributors
Kamil Trzciński's avatar
Kamil Trzciński committed
101

102
## License
Kamil Trzciński's avatar
Kamil Trzciński committed
103

104
This code is distributed under the MIT license, see the [LICENSE](LICENSE) file.