Skip to content

Commit 522add1

Browse files
authored
Update documentation for fork and v4 release (#3)
1 parent e79d3ce commit 522add1

2 files changed

Lines changed: 15 additions & 8 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22

33
- run a specific step in docker.
44
- run an image built by a previous step.
5-
- See https://github.com/addnab/docker-run-action/blob/main/action.yml for all the available inputs.
5+
- See https://github.com/wpilibsuite/docker-run-action/blob/main/action.yml for all the available inputs.
66

77
## Examples
88

99
#### Typical Use Case
1010

1111
```yaml
1212
- name: Checkout
13-
uses: actions/checkout@v2 # Required to mount the Github Workspace to a volume
14-
- uses: addnab/docker-run-action@v3
13+
uses: actions/checkout@v6 # Required to mount the Github Workspace to a volume
14+
- uses: wpilibsuite/docker-run-action@v4
1515
with:
1616
username: ${{ secrets.DOCKER_USERNAME }}
1717
password: ${{ secrets.DOCKER_PASSWORD }}
@@ -25,7 +25,7 @@
2525
2626
#### run a privately-owned image
2727
```yaml
28-
- uses: addnab/docker-run-action@v3
28+
- uses: wpilibsuite/docker-run-action@v4
2929
with:
3030
username: ${{ secrets.DOCKER_USERNAME }}
3131
password: ${{ secrets.DOCKER_PASSWORD }}
@@ -36,11 +36,11 @@
3636
3737
#### run an image built by a previous step
3838
```yaml
39-
- uses: docker/build-push-action@v2
39+
- uses: docker/build-push-action@v6
4040
with:
4141
tags: test-image:latest
4242
push: false
43-
- uses: addnab/docker-run-action@v3
43+
- uses: wpilibsuite/docker-run-action@v4
4444
with:
4545
image: test-image:latest
4646
run: echo "hello world"
@@ -50,7 +50,7 @@
5050
#### use a specific shell (default: sh).
5151
*Note: The shell must be installed in the container*
5252
```yaml
53-
- uses: addnab/docker-run-action@v3
53+
- uses: wpilibsuite/docker-run-action@v4
5454
with:
5555
image: docker:latest
5656
shell: bash

RELEASES.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
# addnab/docker-run-action Releases
1+
# wpilibsuite/docker-run-action Releases
2+
3+
### 4.0.0
4+
5+
- forked from https://github.com/addnab/docker-run-action
6+
- Upgrade to docker 29.1 https://github.com/wpilibsuite/docker-run-action/pull/1
7+
- Replace deprecated uses of set-output in tests https://github.com/wpilibsuite/docker-run-action/pull/2
8+
- Use bash shell parameter expansion instead of semicolon_delimited_script https://github.com/addnab/docker-run-action/pull/17
29

310
### 3.0.0
411

0 commit comments

Comments
 (0)