Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gitlabhq/gitlab-shell

Replacement for gitolite. This repo is a mirror of https://gitlab.com/gitlab-org/gitlab-shell/
https://github.com/gitlabhq/gitlab-shell

Last synced: about 1 month ago
JSON representation

Replacement for gitolite. This repo is a mirror of https://gitlab.com/gitlab-org/gitlab-shell/

Host: GitHub
URL: https://github.com/gitlabhq/gitlab-shell
Owner: gitlabhq
License: mit
Created: 2013-02-04T08:11:01.000Z (almost 12 years ago)
Default Branch: main
Last Pushed: 2024-03-21T02:20:25.000Z (9 months ago)
Last Synced: 2024-03-26T05:17:59.456Z (9 months ago)
Language: Go
Homepage:
Size: 6.54 MB
Stars: 517
Watchers: 77
Forks: 316
Open Issues: 51
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .gitlab/CODEOWNERS
- Support: support/gitlab_config.rb

Awesome Lists containing this project

README

        ---

stage: Create

group: Source Code

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

---

[![pipeline status](https://gitlab.com/gitlab-org/gitlab-shell/badges/main/pipeline.svg)](https://gitlab.com/gitlab-org/gitlab-shell/-/pipelines?ref=main)

[![coverage report](https://gitlab.com/gitlab-org/gitlab-shell/badges/main/coverage.svg)](https://gitlab.com/gitlab-org/gitlab-shell/-/pipelines?ref=main)

[![Code Climate](https://codeclimate.com/github/gitlabhq/gitlab-shell.svg)](https://codeclimate.com/github/gitlabhq/gitlab-shell)

# GitLab Shell

GitLab Shell handles Git SSH sessions for GitLab and modifies the list of

authorized keys. GitLab Shell is not a Unix shell nor a replacement for Bash or Zsh.

GitLab supports Git LFS authentication through SSH.

## Development Documentation

Development documentation for GitLab Shell [has moved into the `gitlab` repository](https://docs.gitlab.com/ee/development/gitlab_shell/).

## Project structure

| Directory | Description |

|-----------|-------------|

| `cmd/` | 'Commands' that will ultimately be compiled into binaries. |

| `internal/` | Internal Go source code that is not intended to be used outside of the project/module. |

| `client/` | HTTP and GitLab client logic that is used internally and by other modules, e.g. Gitaly. |

| `bin/` | Compiled binaries are created here. |

| `support/` | Scripts and tools that assist in development and/or testing. |

| `spec/` | Ruby based integration tests. |

## Building

Run `make` or `make build`.

## Testing

Run `make test`.

## Release Process

1. Create a `gitlab-org/gitlab-shell` MR to update [`VERSION`](https://gitlab.com/gitlab-org/gitlab-shell/-/blob/main/VERSION) and [`CHANGELOG`](https://gitlab.com/gitlab-org/gitlab-shell/-/blob/main/CHANGELOG) files, e.g. [Release v14.39.0](https://gitlab.com/gitlab-org/gitlab-shell/-/merge_requests/1123).

2. Once `gitlab-org/gitlab-shell` MR is merged, create the corresponding git tag, e.g. https://gitlab.com/gitlab-org/gitlab-shell/-/tags/v14.39.0.

3. Create a `gitlab-org/gitlab` MR to update [`GITLAB_SHELL_VERSION`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/GITLAB_SHELL_VERSION) to the proposed tag, e.g. [Bump GitLab Shell to 14.39.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/162661).

4. Announce in `#gitlab-shell` a new version has been created.

## Licensing

See the `LICENSE` file for licensing information as it pertains to files in

this repository.