diff --git a/README.md b/README.md index 7c3720cdb1eaa65915362139af7471bb6d1fc37c..075b45d35634ce73ce303cc75d7f327607eb228b 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ modifying the current one. We ended to do it the following way: That way, the things are kept as close as possible to a standard dev/stage/prod environment but still in the same repo, keeping it simple to understand. -> 💡 Before diving into it, you may want to check the +> :bulb: Before diving into it, you may want to check the [documentation](https://docs.gitlab.com/ce/ci/README.html) and some [real world examples](https://docs.gitlab.com/ce/ci/examples/README.html). @@ -35,7 +35,7 @@ described here: https://docs.gitlab.com/runner/install/ It creates the gitlab-runner user on your system. -> 💡 On some Linux, you may want to +> :bulb: On some Linux, you may want to remove the `~/.bash_logout` file to avoid the issue [4092](https://gitlab.com/gitlab-org/gitlab-runner/issues/4092) — thanks me later. @@ -70,7 +70,7 @@ be used by default. In the `.gitlab-ci.yaml` files, all the jobs are set to be run with the tags "test" — please double check that this tag is defined in the runner configuration, or allow your runner to be ran without any tags. -> 💡 Read more about tags here: https://docs.gitlab.com/ee/ci/runners/#using-tags +> :bulb: Read more about tags here: https://docs.gitlab.com/ee/ci/runners/#using-tags ## Check and edit the `.gitlab-ci.yaml` @@ -81,14 +81,14 @@ In short, this file defines the pipeline process, which contain stages. A stage can contains jobs, which describes what to do. Jobs can be parallel and manual, as of the "deploy_to_production" job. -> 💡 Note that if you want to keep "produced" files between jobs, you have to use the +> :bulb: Note that if you want to keep "produced" files between jobs, you have to use the [artifacts](https://docs.gitlab.com/ce/user/project/pipelines/job_artifacts.html) system. The file of this project define 4 stages: - - test → just prints out some env variables. - - build → creates the README.pdf. - - deploy → creates the release via the `deploy.sh` script. Need a variable. - - control → final steps, does nothing but echoing a string. + - test: just prints out some env variables. + - build: creates the README.pdf. + - deploy: creates the release via the `deploy.sh` script. Need a variable. + - control: final steps, does nothing but echoing a string. 