Skip to content

Commit de4afc4

Browse files
authored
Merge branch 'main' into dependabot/github_actions/actions/download-artifact-4
2 parents d2d9b6c + afd2b1e commit de4afc4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+22
-2428
lines changed

.github/workflows/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
- name: Git Checkout
1919
uses: actions/checkout@v4
2020
- name: Setup Go environment
21-
uses: actions/setup-go@v4
21+
uses: actions/setup-go@v5
2222
with:
2323
go-version: '1.x'
2424
- name: Install Dependencies

Makefile

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -170,22 +170,8 @@ tools-tidy:
170170
cd tools; go mod tidy
171171

172172
.PHONY: prepare-for-pr
173-
prepare-for-pr: check-links test tools-tidy katacoda
173+
prepare-for-pr: check-links test tools-tidy
174174
@echo "========"
175175
@echo "It looks good! :)"
176176
@echo "Make sure to commit all changes!"
177177
@echo "========"
178-
179-
.PHONY: katacoda
180-
katacoda:
181-
@echo "========"
182-
@echo "Generating Katacoda docs..."
183-
@go run katacoda/main.go
184-
@echo "All done!"
185-
@echo "========"
186-
187-
.PHONY: check-katacoda
188-
check-katacoda: katacoda
189-
@echo "Checking if Katacoda docs are up-to-date..."
190-
@git diff --quiet HEAD -- katacoda/scenarios || ( echo "Katacoda docs are not up-to-date! Please run 'make katacoda' and commit the katacoda/scenarios folder" && exit 1)
191-
@echo "All katacoda docs are up-to-date"

content/docs/app-developer-guide/_index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ include_summaries=true
55
expand=true
66
+++
77

8-
{{< katacoda-button href="https://katacoda.com/buildpacks/scenarios/app-developer-guide" color="green" >}} Learn on Katacoda {{</>}}
9-
108
## Prerequisites
119

1210
A lot of the examples used within this guide will require the following:

content/docs/app-developer-guide/build-an-app.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,6 @@ docker run --rm -p 8080:8080 sample-app
6262
The app should now be running and accessible via [localhost:8080](http://localhost:8080).
6363
<!--+end+-->
6464

65-
<!--+ `
66-
Now open your favorite browser and point it to port "8080" of your host and take a minute to enjoy the view.
67-
68-
On Katacoda you can do this by [clicking here](https://[[HOST_SUBDOMAIN]]-8080-[[KATACODA_HOST]].environments.katacoda.com)
69-
` +-->
70-
7165
## What about ARM apps?
7266

7367
Linux ARM image builds are now supported!

content/docs/app-developer-guide/using-inline-buildpacks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ version = "1.0"
2323
id = "me/rake-tasks"
2424

2525
[io.buildpacks.group.script]
26-
api = "0.6"
26+
api = "0.10"
2727
inline = "rake package"
2828
```
2929

@@ -38,7 +38,7 @@ Inline buildpacks aren't constrained to a single command, however. You can defin
3838
id = "me/cleanup"
3939

4040
[io.buildpacks.group.script]
41-
api = "0.9"
41+
api = "0.10"
4242
inline = """
4343
set -e
4444
source scripts/utils.sh

content/docs/app-journey.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,13 @@ getting-started=true
77
## Pack for the journey
88

99
In this tutorial, we'll explain how to use `pack` and **buildpacks** to create a runnable app image from source code.
10-
<!--+if false+-->
11-
{{< katacoda-button href="https://katacoda.com/buildpacks/scenarios/app-journey" color="green" >}} Learn on Katacoda {{</>}}
1210

1311
In order to run the build process in an isolated fashion, `pack` uses **Docker**. That means you'll need to make sure you have both `docker` and `pack` installed:
1412

1513
{{< download-button href="https://store.docker.com/search?type=edition&offering=community" color="blue" >}} Install Docker {{</>}}
1614

1715
{{< download-button href="/docs/install-pack" color="pink" >}} Install pack {{</>}}
18-
<!--+end+-->
16+
1917
> **NOTE:** `pack` is only one implementation of the [Cloud Native Buildpacks Platform Specification][cnb-platform-spec]. Additionally, not all Cloud Native Buildpacks Platforms require Docker.
2018
2119
[cnb-platform-spec]: https://github.com/buildpacks/spec/blob/main/platform.md
@@ -86,14 +84,8 @@ To test out your new app image locally, you can run it with Docker:
8684
docker run --rm -p 8080:8080 myapp
8785
```
8886
<!--+- "{{execute}}"+-->
89-
<!--+- if false+-->
9087
Now hit [`localhost:8080`](http://localhost:8080) in your favorite browser and take a minute to enjoy the view.
91-
<!--+- end+-->
92-
<!--+ `
93-
Now open your favorite browser and point it to port "8080" of your host and take a minute to enjoy the view.
9488

95-
On Katacoda you can do this by [clicking here](https://[[HOST_SUBDOMAIN]]-8080-[[KATACODA_HOST]].environments.katacoda.com)
96-
` +-->
9789

9890
### Take your image to the skies
9991

@@ -107,9 +99,7 @@ deploying your new image to your favorite cloud!
10799

108100
Windows image builds are now supported!
109101

110-
<!--+- if false+-->
111102
<a href="/docs/app-developer-guide/build-a-windows-app" class="button bg-blue">Windows build guide</a>
112-
<!--+end+-->
113103

114104
[builder]: /docs/concepts/components/builder/
115105
[buildpack]: /docs/concepts/components/buildpack/

content/docs/buildpack-author-guide/create-buildpack/adding-bill-of-materials.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ First, annotate the `buildpack.toml` to specify that it emits CycloneDX:
4343
<!-- test:file=node-js-buildpack/buildpack.toml -->
4444
```toml
4545
# Buildpack API version
46-
api = "0.8"
46+
api = "0.10"
4747

4848
# Buildpack ID and metadata
4949
[buildpack]
@@ -144,7 +144,7 @@ EOL
144144
cat >> "${CNB_LAYERS_DIR}/launch.toml" << EOL
145145
[[processes]]
146146
type = "web"
147-
command = "node app.js"
147+
command = ["node", "app.js"]
148148
default = true
149149
EOL
150150

content/docs/buildpack-author-guide/create-buildpack/building-blocks-cnb.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Example:
1717
<!-- test:exec -->
1818
```bash
1919
pack buildpack new examples/node-js \
20-
--api 0.8 \
20+
--api 0.10 \
2121
--path node-js-buildpack \
2222
--version 0.0.1 \
2323
--stacks io.buildpacks.samples.stacks.jammy
@@ -40,7 +40,7 @@ You will have `node-js-buildpack/buildpack.toml`<!--+"{{open}}"+--> in your buil
4040
<!-- test:file=node-js-buildpack/buildpack.toml -->
4141
```toml
4242
# Buildpack API version
43-
api = "0.8"
43+
api = "0.10"
4444

4545
# Buildpack ID and metadata
4646
[buildpack]
@@ -91,7 +91,7 @@ These two files are executable `detect` and `build` scripts. You are now able to
9191

9292
### Using your buildpack with `pack`
9393

94-
In order to test your buildpack, you will need to run the buildpack against your sample Ruby app using the `pack` CLI.
94+
In order to test your buildpack, you will need to run the buildpack against your sample Node.js app using the `pack` CLI.
9595

9696
Set your default [builder][builder] by running the following:
9797

@@ -117,7 +117,7 @@ pack build test-node-js-app --path ./node-js-sample-app --buildpack ./node-js-bu
117117
```
118118
<!--+- "{{execute}}"+-->
119119

120-
The `pack build` command takes in your Ruby sample app as the `--path` argument and your buildpack as the `--buildpack` argument.
120+
The `pack build` command takes in your Node.js sample app as the `--path` argument and your buildpack as the `--buildpack` argument.
121121

122122
After running the command, you should see that it failed to detect, as the `detect` script is currently written to simply error out.
123123

@@ -137,4 +137,4 @@ ERROR: failed to detect: buildpack(s) failed with err
137137
<a href="/docs/buildpack-author-guide/create-buildpack/detection" class="button bg-pink">Next Step</a>
138138

139139
[builder]: /docs/concepts/components/builder
140-
<!--+ end +-->
140+
<!--+ end +-->

content/docs/buildpack-author-guide/create-buildpack/caching.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,13 @@ cat > "${CNB_LAYERS_DIR}/launch.toml" << EOL
5454
# our web process
5555
[[processes]]
5656
type = "web"
57-
command = "node app.js"
57+
command = ["node", "app.js"]
5858
default = true
5959
6060
# our debug process
6161
[[processes]]
6262
type = "debug"
63-
command = "node --inspect app.js"
63+
command = ["node", "--inspect", "app.js"]
6464
EOL
6565
```
6666

@@ -121,7 +121,7 @@ EOL
121121
cat >> "${CNB_LAYERS_DIR}/launch.toml" << EOL
122122
[[processes]]
123123
type = "web"
124-
command = "node app.js"
124+
command = ["node", "app.js"]
125125
default = true
126126
EOL
127127
```

content/docs/buildpack-author-guide/create-buildpack/make-app-runnable.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ To make your app runnable, a default start command must be set. You'll need to a
1515
cat > "${CNB_LAYERS_DIR}/launch.toml" << EOL
1616
[[processes]]
1717
type = "web"
18-
command = "node app.js"
18+
command = ["node", "app.js"]
1919
default = true
2020
EOL
2121

@@ -48,7 +48,7 @@ echo -e '[types]\nlaunch = true' > "${CNB_LAYERS_DIR}/node-js.toml"
4848
cat > "${CNB_LAYERS_DIR}/launch.toml" << EOL
4949
[[processes]]
5050
type = "web"
51-
command = "node app.js"
51+
command = ["node", "app.js"]
5252
default = true
5353
EOL
5454
```

0 commit comments

Comments
 (0)