Add GitLab docs linting image to project, based on existing docs image for linting

This commit is contained in:
Evan Read 2018-09-17 08:50:10 +10:00
parent a561aa78a8
commit 80e889b8f0
3 changed files with 36 additions and 15 deletions

View file

@ -1,3 +1,5 @@
# GitLab Build Images
This repository is used to build docker images that are used to build and test
various parts of GitLab:
@ -5,25 +7,25 @@ various parts of GitLab:
1. Test GitLab-CE/EE project
1. Build gitlab-org/www-gitlab-com project
# Adding a new image
## Adding a new image
There are two methods to adding a new image:
1. Use a docker buildfile
2. Use a custom image with versioned features
## Use a docker buildfile
1. Use a docker buildfile.
1. Use a custom image with versioned features.
### Use a docker buildfile
A bespoke image is one that uses it's own Dockerfile. In the interests of
avoiding repetition, it's better to use the custom docker build if possible.
Assuming the image you want to add is called `new-image`....
Assuming the image you want to add is called `new-image`:
1. Add a test task: `new-image test: *test_build`
1. Add a new build task: `new-image: *build_and_deploy`
1. Add a Dockerfile: `Dockerfile.new-image`
1. Add a test task: `new-image test: *test_build`.
1. Add a new build task: `new-image: *build_and_deploy`.
1. Add a Dockerfile: `Dockerfile.new-image`.
## Use a custom image with versioned features
### Use a custom image with versioned features
To add a new image to the build, edit [`.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab-build-images/blob/master/.gitlab-ci.yml).
@ -56,7 +58,7 @@ options are:
1. `ansible`
1. `graphicsmagick`
### Adding a new build
#### Adding a new build
As an example, if you want to add new image for Ruby 2.4 with `git` 2.14 and `golang` 1.9,
the name would be `ruby-2.4-golang-1.9-git-2.14`.
@ -64,15 +66,15 @@ the name would be `ruby-2.4-golang-1.9-git-2.14`.
1. Add a test task: `ruby-2.4-golang-1.9-git-2.14 test: *test_custom`
1. Add a new build task: `ruby-2.4-golang-1.9-git-2.14: *build_and_deploy_custom`
# Note regarding Google Chrome
## Note regarding Google Chrome
Google has a policy of yanking older versions of Google Chrome from their PPA
whenever a new major version is released. To help maintain consistant build
whenever a new major version is released. To help maintain consistent build
images, there is a CI step that saves the latest Google Chrome .deb into an S3
bucket. The install for Chrome will attempt to retrieve from the bucket if it
bucket. The install for Chrome will attempt to retrieve from the bucket if it
cannot find the file in the apt repository. See `scripts/cache-google-chrome`
for more details.
# Contributing
## Contributing
See [Contributing](CONTRIBUTING.md)