Skip to content
Snippets Groups Projects
Commit 9cb72646 authored by Marcel Amirault's avatar Marcel Amirault Committed by Achilleas Pipinellis
Browse files

Start linting for unneeded dollar signs

Do not use dollar signs in shell codeblocks when
no output is shown, in omnibus docs
parent 273374f8
No related branches found
No related tags found
No related merge requests found
Loading
Loading
@@ -8,7 +8,6 @@
"style": "dash"
},
"line-length": false,
"commands-show-output": false,
"no-duplicate-header": {
"allow_different_nesting": true
},
Loading
Loading
Loading
Loading
@@ -10,7 +10,7 @@ for instructions on how to prepare build environment using Docker.
You create a platform-specific package using the `build` command:
 
```shell
$ bin/omnibus build gitlab
bin/omnibus build gitlab
```
 
The platform/architecture type of the package created will match the platform
Loading
Loading
@@ -24,7 +24,7 @@ You can clean up all temporary files generated during the build process with
the `clean` command:
 
```shell
$ bin/omnibus clean
bin/omnibus clean
```
 
Adding the `--purge` purge option removes __ALL__ files generated during the
Loading
Loading
@@ -32,7 +32,7 @@ build including the project install directory (`/opt/gitlab`) and
the package cache directory (`/var/cache/omnibus/pkg`):
 
```shell
$ bin/omnibus clean --purge
bin/omnibus clean --purge
```
 
### Help
Loading
Loading
@@ -41,7 +41,7 @@ Full help for the Omnibus command line interface can be accessed with the
`help` command:
 
```shell
$ bin/omnibus help
bin/omnibus help
```
 
## Build Docker image
Loading
Loading
Loading
Loading
@@ -12,7 +12,7 @@ E: Failed to fetch https://packages.gitlab.com/gitlab/gitlab-ce/ubuntu/pool/trus
 
Please run the following to fix this:
 
```
```sh
sudo rm -rf /var/lib/apt/lists/partial/*
sudo apt-get update
sudo apt-get clean
Loading
Loading
@@ -22,7 +22,7 @@ See [Joe Damato's from Packagecloud comment](https://gitlab.com/gitlab-org/omnib
 
Another workaround is to download the package manually by selecting the correct package from the [CE packages](https://packages.gitlab.com/gitlab/gitlab-ce) or [EE packages](https://packages.gitlab.com/gitlab/gitlab-ee) repository:
 
```
```sh
curl -LJO https://packages.gitlab.com/gitlab/gitlab-ce/packages/ubuntu/trusty/gitlab-ce_8.1.0-ce.0_amd64.deb/download
dpkg -i gitlab-ce_8.1.0-ce.0_amd64.deb
```
Loading
Loading
@@ -105,7 +105,7 @@ not used in your GitLab instance yet.
If necessary, you can modify the 'From' field of the emails sent by GitLab with
the following setting in `/etc/gitlab/gitlab.rb`:
 
```
```rb
gitlab_rails['gitlab_email_from'] = 'gitlab@example.com'
```
 
Loading
Loading
@@ -120,7 +120,7 @@ To troubleshoot this error:
1. First check that the runit directory exists:
 
```sh
$ ls -al /opt/gitlab/sv/redis/supervise
ls -al /opt/gitlab/sv/redis/supervise
```
 
1. If you see the message, continue to the next step:
Loading
Loading
@@ -132,20 +132,20 @@ To troubleshoot this error:
1. Restart the runit server.
Using systemctl (Debian => 9 - Stretch):
 
```
$ sudo systemctl restart gitlab-runsvdir
```sh
sudo systemctl restart gitlab-runsvdir
```
 
Using upstart (Ubuntu <= 14.04):
 
```
$ sudo initctl restart gitlab-runsvdir
```sh
sudo initctl restart gitlab-runsvdir
```
 
Using systemd (CentOS, Ubuntu >= 16.04):
 
```
$ systemctl restart gitlab-runsvdir.service
```sh
systemctl restart gitlab-runsvdir.service
```
 
*Note* This should be resolved starting from 7.13 Omnibus GitLab packages.
Loading
Loading
Loading
Loading
@@ -35,7 +35,7 @@ writing specs can be skipped. However, an issue to implement the tests
 
To run tests, execute the following command (you may have to run `bundle install` before running it)
 
```
```sh
bundle exec rspec
```
 
Loading
Loading
@@ -61,9 +61,7 @@ their applicability:
1. If Merge Request introduces change in user facing configuration, update to [`gitlab.rb.template`](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/files/gitlab-config-template/gitlab.rb.template)
1. [Changelog entry](https://docs.gitlab.com/ce/development/changelog.html) to inform about the change, if necessary.
 
**`Note:`** Ensure shared runners are enabled for your fork in order for our automated tests to run.[^1]
[^1]:
**Note:** Ensure shared runners are enabled for your fork in order for our automated tests to run:
 
1. Go to Settings -> CI/CD
1. Expand Runners settings
Loading
Loading
@@ -80,12 +78,12 @@ build and confirm it there. To use this:
1. Copy the [simple.rb](examples/simple.rb) file into your projects
 
```shell
$ cp doc/development/examples/simple.rb config/projects/
cp doc/development/examples/simple.rb config/projects/
```
 
1. Change the `dependency` in `config/projects/simple.rb` to match the software you are testing
1. Build the simple project by running
 
```shell
$ bundle exec omnibus build simple
bundle exec omnibus build simple
```
Loading
Loading
@@ -16,13 +16,13 @@ up a Build Environment](../build/prepare-build-environment.md).
 
1. Pulling a Debian Jessie image
 
```
```sh
docker pull debian:jessie
```
 
1. Running docker image with a shell prompt
 
```
```sh
docker run -it debian:jessie bash
```
 
Loading
Loading
@@ -34,7 +34,7 @@ up a Build Environment](../build/prepare-build-environment.md).
Basic tools used for developing Omnibus GitLab may be installed using the
following command
 
```
```sh
sudo apt-get install git
```
 
Loading
Loading
@@ -55,7 +55,7 @@ up a Build Environment](../build/prepare-build-environment.md).
 
Get the source code of Omnibus GitLab from the [repository on GitLab.com](https://gitlab.com/gitlab-org/omnibus-gitlab)
 
```
```sh
git clone https://gitlab.com/gitlab-org/omnibus-gitlab.git ~/omnibus-gitlab
```
 
Loading
Loading
@@ -69,7 +69,7 @@ up a Build Environment](../build/prepare-build-environment.md).
installation. This involves backing up of the existing cookbooks directory
and symlinking the directory where we make modifications to its location.
 
```
```sh
sudo mv /opt/gitlab/embedded/cookbooks/gitlab /opt/gitlab/embedded/cookbooks/gitlab.$(date +%s)
sudo ln -s ~/omnibus-gitlab/files/gitlab-cookbooks/gitlab /opt/gitlab/embedded/cookbooks/gitlab
```
Loading
Loading
@@ -78,7 +78,7 @@ up a Build Environment](../build/prepare-build-environment.md).
 
Before running `reconfigure`, you need to start runsv.
 
```
```sh
/opt/gitlab/embedded/bin/runsvdir-start &
```
 
Loading
Loading
@@ -100,26 +100,26 @@ This ensures that your new work is behaving as expected, and not breaking anythi
 
1. Clone the [GitLab EE](https://gitlab.com/gitlab-org/gitlab-ee) repository
 
```
$ git clone git@gitlab.com:gitlab-org/gitlab-ee.git
```sh
git clone git@gitlab.com:gitlab-org/gitlab-ee.git
```
 
1. Change to the `qa` directory
 
```
$ cd gitlab-ee/qa
```sh
cd gitlab-ee/qa
```
 
1. Install the required gems
 
```
$ bundle install
```sh
bundle install
```
 
1. Run the tests
 
```
$ GITLAB_USERNAME=$USERNAME GITLAB_PASSWORD=$PASSWORD bundle exec bin/qa Test::Instance $DEV_INSTANCE_URL
```sh
GITLAB_USERNAME=$USERNAME GITLAB_PASSWORD=$PASSWORD bundle exec bin/qa Test::Instance $DEV_INSTANCE_URL
```
 
## Openshift GitLab Development Setup
Loading
Loading
Loading
Loading
@@ -277,7 +277,7 @@ You then need to appropriately configure `gitlab.rb`:
 
1. Set `external_url`:
 
```
```rb
# For HTTP
external_url "http://gitlab.example.com:8929"
 
Loading
Loading
@@ -293,7 +293,7 @@ You then need to appropriately configure `gitlab.rb`:
 
1. Set `gitlab_shell_ssh_port`:
 
```
```rb
gitlab_rails['gitlab_shell_ssh_port'] = 2289
```
 
Loading
Loading
@@ -444,7 +444,7 @@ Here's an example that deploys GitLab with four runners as a [stack](https://doc
 
1. Create a `root_password.txt` file:
 
```
```text
MySuperSecretAndSecurePass0rd!
```
 
Loading
Loading
@@ -527,7 +527,7 @@ default:other::r-x
If these are not correct, set them with:
 
```bash
$ sudo setfacl -mR default:group:docker:rwx /srv/gitlab
sudo setfacl -mR default:group:docker:rwx /srv/gitlab
```
 
[^1]: `docker` is the default group, if you've changed this, update your commands accordingly.
Loading
Loading
Loading
Loading
@@ -211,8 +211,8 @@ means there may be one of three issues:
Test the certificate's validity using the commands below:
 
```sh
$ /opt/gitlab/embedded/bin/openssl x509 -in /etc/gitlab/trusted-certs/example.pem -text -noout
$ /opt/gitlab/embedded/bin/openssl x509 -inform DER -in /etc/gitlab/trusted-certs/example.der -text -noout
/opt/gitlab/embedded/bin/openssl x509 -in /etc/gitlab/trusted-certs/example.pem -text -noout
/opt/gitlab/embedded/bin/openssl x509 -inform DER -in /etc/gitlab/trusted-certs/example.der -text -noout
```
 
Invalid certificate files produce the following output:
Loading
Loading
@@ -224,8 +224,8 @@ unable to load certificate
 
To test if `c_rehash` is not symlinking the certificate due to a missing perl interpreter:
 
```
/opt/gitlab/embedded/bin/c_rehash /etc/gitlab/trusted-certs
```sh
$ /opt/gitlab/embedded/bin/c_rehash /etc/gitlab/trusted-certs
bash: /opt/gitlab/embedded/bin/c_rehash: /usr/bin/perl: bad interpreter: No such file or directory
```
 
Loading
Loading
Loading
Loading
@@ -109,26 +109,26 @@ The `debsig-verify` package has a [slew of dependencies](https://packages.debian
 
1. Download and import the package signing public key
 
```
$ curl -JLO https://packages.gitlab.com/gitlab/gitlab-ce/gpgkey/gitlab-gitlab-ce-3D645A26AB9FBD22.pub.gpg
$ gpg --import gitlab-gitlab-ce-3D645A26AB9FBD22.pub.gpg
```sh
curl -JLO https://packages.gitlab.com/gitlab/gitlab-ce/gpgkey/gitlab-gitlab-ce-3D645A26AB9FBD22.pub.gpg
gpg --import gitlab-gitlab-ce-3D645A26AB9FBD22.pub.gpg
```
 
1. Extract the signature file (`_gpgorigin`)
 
```
$ ar x gitlab-ce-xxx.deb _gpgorigin
```sh
ar x gitlab-ce-xxx.deb _gpgorigin
```
 
1. Verify the signature matches the content
 
```
$ ar p gitlab-xxx.deb debian-binary control.tar.gz data.tar.gz | gpg --verify _gpgorigin -
```sh
ar p gitlab-xxx.deb debian-binary control.tar.gz data.tar.gz | gpg --verify _gpgorigin -
```
 
The output of the final command should appear as such:
 
```
```sh
$ ar p gitlab-xxx.deb debian-binary control.tar.gz data.tar.gz | gpg --verify _gpgorigin -
gpg: Signature made Tue Aug 01 22:21:11 2017 UTC
gpg: using RSA key DBEF89774DDB9EB37D9FC3A03CFCF9BAF27EAB47
Loading
Loading
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment