Skip to content

Commit f002be2

Browse files
committed
remove "example" from CI checks
Previously, I added a step to the CircleCI checks that runs the example/ using the most recent release. At one point, I restructured the repository and the example/ stopped working, but I didn't notice. The CI check was an attempt to prevent that in the future. Now it's a pain, though, because anything that might "break" the example cannot be "fixed" in CI without a release. Let's revisit how to automate verification that example/ is working. For now, I'm removing the check to reduce operational burden.
1 parent 3581ac9 commit f002be2

File tree

1 file changed

+0
-65
lines changed

1 file changed

+0
-65
lines changed

.circleci/config.yml

Lines changed: 0 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -111,50 +111,6 @@ jobs:
111111
exit 1
112112
fi
113113
114-
example:
115-
parameters:
116-
# `base-image` is the docker image on top of which the example nginx image
117-
# will be built. The corresponding nginx-datadog release will be
118-
# downloaded from GitHub and installed.
119-
base-image:
120-
type: string
121-
default: ""
122-
# `nginx-modules-path` is the file system path of a directory where nginx
123-
# looks for modules. It is not, surprisingly, always consistent with the
124-
# `--modules-path` argument to nginx's `./configure` script.
125-
nginx-modules-path:
126-
type: string
127-
default: ""
128-
# `nginx-conf-path` is the file system path to nginx's configuration file.
129-
nginx-conf-path:
130-
type: string
131-
default: ""
132-
docker:
133-
# "cimg" means "convenience image." Helpful images provided by CircleCI.
134-
# This one docker-compose and a bunch of other things.
135-
# See https://circleci.com/docs/circleci-images
136-
- image: cimg/base:current
137-
environment:
138-
# See https://github.com/containers/podman/issues/13889
139-
DOCKER_BUILDKIT: 0
140-
BASE_IMAGE: << parameters.base-image >>
141-
NGINX_MODULES_PATH: << parameters.nginx-modules-path >>
142-
NGINX_CONF_PATH: << parameters.nginx-conf-path >>
143-
DD_API_KEY: this-is-a-bogus-api-key
144-
steps:
145-
- checkout
146-
- setup_remote_docker:
147-
# Cache docker layers somewhere so that we don't have to rebuild test
148-
# service images every time.
149-
docker_layer_caching: true
150-
- run:
151-
working_directory: ~/project/example
152-
command: docker-compose up --build --detach
153-
- run: 'echo "sleeping for a bit to let the services come up..."; sleep 30'
154-
- run:
155-
working_directory: ~/project/example
156-
command: bin/check
157-
158114
shellcheck:
159115
docker:
160116
- image: koalaman/shellcheck-alpine:stable
@@ -171,27 +127,6 @@ workflows:
171127
filters:
172128
tags:
173129
only: /^v[0-9]+\.[0-9]+\.[0-9]+/
174-
# Running the example doesn't tell us anything about the proposed pull
175-
# request or candidate release, but it's here as a check to break should any
176-
# changes break the example.
177-
- example:
178-
name: "run the example on Amazon Linux"
179-
base-image: "amazonlinux:2.0.20230119.1"
180-
filters:
181-
tags:
182-
only: /^v[0-9]+\.[0-9]+\.[0-9]+/
183-
- example:
184-
name: "run the example on Debian"
185-
base-image: "nginx:1.23.2"
186-
filters:
187-
tags:
188-
only: /^v[0-9]+\.[0-9]+\.[0-9]+/
189-
- example:
190-
name: "run the example on Alpine"
191-
base-image: "nginx:1.23.2-alpine"
192-
filters:
193-
tags:
194-
only: /^v[0-9]+\.[0-9]+\.[0-9]+/
195130
# The following are generated by `../bin/generate_jobs_yaml.sh`.
196131
- build:
197132
name: "build on amazonlinux:2.0.20230418.0"

0 commit comments

Comments
 (0)