|
1 | 1 | # GitHub Actions
|
2 | 2 | This document describes the current CI for the ce-dev project. The CI is written for GitHub Actions, the built in GitHub system for orchestration and automation. We operate three separate GitHub Actions workflows.
|
3 | 3 |
|
4 |
| -## ce-dev-build-dev |
5 |
| -Builds base and controller images using the contents of the `devel` branch on push. The built images get pushed to Docker Hub and tagged with `devel`. This is very useful for pushing test containers to try out locally. |
| 4 | +### devel-ubuntu-linux.yml |
6 | 5 |
|
7 |
| -### Testing project images |
| 6 | +Linux - Build binaries, images and templates using devel mode. |
| 7 | + |
| 8 | +### ubuntu-linux.yml |
| 9 | + |
| 10 | +Linux - Build binaries, images and templates. Docker images are pushed. New release is created. |
| 11 | + |
| 12 | +# Testing project images |
8 | 13 | To test a `devel` container on a project, firstly fetch the container image:
|
9 | 14 |
|
10 | 15 | ```
|
11 | 16 | docker pull codeenigma/ce-dev-controller:2.x
|
12 | 17 | ```
|
13 | 18 |
|
14 |
| -Then edit your project's `ce-dev.compose.yml` file, changing the image for each applicable service to use the `devel` tag instead of the `latest` tag, for example: |
| 19 | +Then edit your project's `ce-dev.compose.yml` file, changing the image for each applicable service to use the `-devel` tag instead of the current tag, for example: |
15 | 20 |
|
16 | 21 | ```yaml
|
17 |
| - image: codeenigma/ce-dev:2.x |
| 22 | + image: codeenigma/ce-dev:2.x -> image: codeenigma/ce-dev:2.x-devel |
18 | 23 | ```
|
19 | 24 |
|
20 | 25 | Finally, destroy and recreate your `docker compose` file and containers:
|
@@ -51,24 +56,7 @@ git merge origin my_test_branch
|
51 | 56 |
|
52 | 57 | Then use `ce-dev provision` and `ce-dev deploy` in the usual way.
|
53 | 58 |
|
54 |
| -### Known issues |
55 |
| -* The golang release needs keeping up to date (there's no 'latest' download we can use) |
56 |
| -* `mkcert` is built from source, initially because of a bad release but now it's like that we might as well keep it that way |
57 |
| - |
58 |
| -## ce-dev-build |
59 |
| -This builds the images and binaries, pushes the Docker containers to Docker Hub, pushes the binaries to a GitHub release and builds and commits the ce-dev documentation. It runs when someone accepts a PR for or pushes to the `2.x` branch and has added a valid tag in the format `2.*`. These images are tagged `latest` in the Docker repository. |
60 |
| - |
61 | 59 | ### Known issues
|
62 | 60 | * The golang release needs keeping up to date (there's no 'latest' download we can use)
|
63 | 61 | * `mkcert` is built from source, initially because of a bad release but now it's like that we might as well keep it that way
|
64 | 62 | * If we start developing in a new version branch we will need to update the `on: push:` YAML in this workflow to allow the new tags or it won't execute
|
65 |
| - |
66 |
| -## ce-dev-lint |
67 |
| -This runs ESLint over the JavaScript code in the `src` directory. It runs on every pull request. It uses the ESLint config defined in `./.eslintrc` so if you need to change its behaviour, edit that file. |
68 |
| - |
69 |
| -## ce-dev-test |
70 |
| -This builds the images and tests the ce-dev stack. It runs on every pull request and daily at 6:30. |
71 |
| - |
72 |
| -### Known issues |
73 |
| -* The golang release needs keeping up to date (there's no 'latest' download we can use) |
74 |
| -* `mkcert` is built from source, initially because of a bad release but now it's like that we might as well keep it that way |
0 commit comments