Skip to content

Commit ab43629

Browse files
authored
Merge pull request #5 from acutedev/update-readme-docker-release
Update Docker release documentation
2 parents d32ac31 + 1e6b350 commit ab43629

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -105,23 +105,25 @@ flowchart TB
105105

106106
## Docker Quick-Start
107107

108-
Docker runs the full workflow without installing Python locally. Versioned prebuilt images will be published to GitHub Container Registry when a GitHub Release is published, and `latest` will be published for stable releases. Until the first release is available, build the image locally using the commands below.
108+
Docker runs the full workflow without installing Python locally. Versioned prebuilt images are published to GitHub Container Registry when a GitHub Release is published, and stable releases are also published with the `latest` tag.
109109

110-
### Prebuilt image after the first release
110+
### Prebuilt image
111111

112-
After the first stable GitHub Release is published, the image will be available at:
112+
The prebuilt image is available at:
113113

114114
```bash
115115
docker pull ghcr.io/acutedev/bug-triage-workflow-python:latest
116116
docker run --rm ghcr.io/acutedev/bug-triage-workflow-python:latest --help
117117
```
118118

119-
Versioned releases will also be available by tag, for example:
119+
Versioned releases are also available by tag, for example:
120120

121121
```bash
122122
docker pull ghcr.io/acutedev/bug-triage-workflow-python:v1.0.0
123123
```
124124

125+
### Build locally
126+
125127
```bash
126128
cp .env.example .env
127129
# add LLM_API_KEY to .env

0 commit comments

Comments
 (0)