github.com/secure-build/gitlab-runner@v12.5.0+incompatible/README.md (about)

     1  # GitLab Runner
     2  
     3  This is the repository of the official GitLab Runner written in Go.
     4  It runs tests and sends the results to GitLab.
     5  [GitLab CI](https://about.gitlab.com/gitlab-ci) is the open-source
     6  continuous integration service included with GitLab that coordinates the testing.
     7  The old name of this project was GitLab CI Multi Runner but please use "GitLab Runner" (without CI) from now on.
     8  
     9  [![Build Status](https://gitlab.com/gitlab-org/gitlab-runner/badges/master/build.svg)](https://gitlab.com/gitlab-org/gitlab-runner/commits/master)
    10  [![Go Report Card](https://goreportcard.com/badge/gitlab.com/gitlab-org/gitlab-runner)](https://goreportcard.com/report/gitlab.com/gitlab-org/gitlab-runner)
    11  
    12  ## Runner and GitLab CE/EE compatibility
    13  
    14  For a list of compatible versions between GitLab and GitLab Runner, consult
    15  the [compatibility section](https://docs.gitlab.com/runner/#compatibility-with-gitlab-versions).
    16  
    17  ## Release process
    18  
    19  The description of release process of GitLab Runner project can be found in the [release documentation](docs/release_process/README.md).
    20  
    21  ## Contributing
    22  
    23  Contributions are welcome, see [`CONTRIBUTING.md`](CONTRIBUTING.md) for more details.
    24  
    25  ### Closing issues and merge requests
    26  
    27  GitLab is growing very fast and we have a limited resources to deal with reported issues
    28  and merge requests opened by the community volunteers. We appreciate all the contributions
    29  coming from our community. But to help all of us with issues and merge requests management
    30  we need to create some closing policy.
    31  
    32  If an issue or merge request has a ~"waiting for feedback" label and the response from the
    33  reporter has not been received for 14 days, we can close it using the following response
    34  template:
    35  
    36  ```
    37  We haven't received an update for more than 14 days so we will assume that the
    38  problem is fixed or is no longer valid. If you still experience the same problem
    39  try upgrading to the latest version. If the issue persists, reopen this issue
    40  or merge request with the relevant information.
    41  ```
    42  
    43  ### Contributing to documentation
    44  
    45  If your contribution contains only documentation changes, you can speed up the CI process
    46  by following some branch naming conventions, as described in <https://docs.gitlab.com/ce/development/documentation/index.html#branch-naming>
    47  
    48  ## Documentation
    49  
    50  The documentation source files can be found under the [docs/](docs/) directory. You can
    51  read the documentation online at <https://docs.gitlab.com/runner/>.
    52  
    53  ## Requirements
    54  
    55  [Read about the requirements of GitLab Runner.](https://docs.gitlab.com/runner/#requirements)
    56  
    57  ## Features
    58  
    59  [Read about the features of GitLab Runner.](https://docs.gitlab.com/runner/#features)
    60  
    61  ## Executors compatibility chart
    62  
    63  [Read about what options each executor can offer.](https://docs.gitlab.com/runner/executors/#compatibility-chart)
    64  
    65  ## Install GitLab Runner
    66  
    67  Visit the [installation documentation](https://docs.gitlab.com/runner/install/).
    68  
    69  ## Use GitLab Runner
    70  
    71  See [https://docs.gitlab.com/runner/#using-gitlab-runner](https://docs.gitlab.com/runner/#using-gitlab-runner).
    72  
    73  ## Select executor
    74  
    75  See [https://docs.gitlab.com/runner/executors/#selecting-the-executor](https://docs.gitlab.com/runner/executors/#selecting-the-executor).
    76  
    77  ## Troubleshooting
    78  
    79  Read the [FAQ](https://docs.gitlab.com/runner/faq/).
    80  
    81  ## Advanced Configuration
    82  
    83  See [https://docs.gitlab.com/runner/#advanced-configuration](https://docs.gitlab.com/runner/#advanced-configuration).
    84  
    85  ## Building and development
    86  
    87  See [https://docs.gitlab.com/runner/development/](https://docs.gitlab.com/runner/development/).
    88  
    89  ## Changelog
    90  
    91  Visit the [Changelog](CHANGELOG.md) to view recent changes.
    92  
    93  ## The future
    94  
    95  - Please see the [GitLab Direction page](https://about.gitlab.com/direction/).
    96  - Feel free submit issues with feature proposals on the issue tracker.
    97  
    98  ## Author
    99  
   100  - 2014 - 2015   : [Kamil Trzciński](mailto:ayufan@ayufan.eu)
   101  - 2015 - now    : GitLab Inc. team and contributors
   102  
   103  ## License
   104  
   105  This code is distributed under the MIT license, see the [LICENSE](LICENSE) file.