Skip to content

Commit 86fe6d4

Browse files
authored
Merge pull request #67 from buildkite/update-nodejs-docker-example
Update Node.js Docker Example (consistency sweep)
2 parents a8ce519 + 624dc7a commit 86fe6d4

File tree

5 files changed

+44
-22
lines changed

5 files changed

+44
-22
lines changed

.buildkite/screenshot.png

287 KB
Loading

.buildkite/template.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
1-
# Used by the 'Add to Buildkite' button in the readme
21
name: "Node.js Docker Example"
2+
description: "An example pipeline that runs tests inside a Docker container using the official Node.js image."
3+
emoji: ":nodejs:"
4+
color: "#F0FDF2"
5+
languages:
6+
- "JavaScript"
7+
- "Docker"
38
steps:
49
- label: ":pipeline:"
510
command: "buildkite-agent pipeline upload"

License.md renamed to LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2016 Buildkite Pty Ltd
3+
Copyright (c) 2025 Buildkite Pty Ltd
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Buildkite Node.js Docker Example
2+
3+
[![Build status](https://badge.buildkite.com/a9d2e75d3a3a450b44b12f0e592899b98375217e54a346cde8.svg?branch=main)](https://buildkite.com/buildkite/nodejs-docker-example/builds/latest?branch=main)
4+
[![Add to Buildkite](https://img.shields.io/badge/Add%20to%20Buildkite-14CC80)](https://buildkite.com/new)
5+
6+
This repository is an example [Buildkite](https://buildkite.com/) pipeline that tests a [Node.js](https://nodejs.org/) project using [Docker](https://docker.com/) and the standard [Node.js Docker image](https://hub.docker.com/_/node/).
7+
8+
👉 **See this example in action:** [buildkite/nodejs-docker-example](https://buildkite.com/buildkite/nodejs-docker-example/builds/latest?branch=main)
9+
10+
[![Add to Buildkite](https://buildkite.com/button.svg)](https://buildkite.com/new)
11+
12+
<a href="https://buildkite.com/buildkite/nodejs-docker-example/builds/latest?branch=main">
13+
<img width="2400" alt="Screenshot of Buildkite Node.js Docker example pipeline" src=".buildkite/screenshot.png" />
14+
</a>
15+
16+
<!-- docs:start -->
17+
18+
## How it works
19+
20+
This example:
21+
- Uses Docker Compose to run `npm test` inside a container
22+
- Uses the official `node` Docker image
23+
- Tests a simple Node.js app in a containerized Buildkite pipeline
24+
25+
<!-- docs:end -->
26+
27+
## Running locally
28+
29+
To run the test outside of Buildkite:
30+
31+
```bash
32+
docker-compose run app npm test
33+
```
34+
35+
## License
36+
37+
See [LICENSE.md](LICENSE.md) (MIT)

Readme.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)