Skip to content

Commit

Permalink
Merge pull request #23 from LukasBommes/fix_readme
Browse files Browse the repository at this point in the history
fixed wrong command in readme
  • Loading branch information
LukasBommes authored Sep 12, 2022
2 parents 75424af + 9fe4c11 commit 995ed82
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Build

on: [push, pull_request]
on: [workflow_dispatch]

jobs:
build_docker:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ git clone https://github.com/LukasBommes/mv-extractor.git mv_extractor

Afterwards, you can run the extraction script in the `mv_extractor` directory as follows
```
sudo ./run.sh python3.10 extract_mvs.py --preview --verbose
sudo ./run.sh python3.10 extract_mvs.py vid_h264.mp4 --preview --verbose
```
This pulls the prebuild Docker image from DockerHub and runs the extraction script inside the Docker container.

Expand Down
12 changes: 8 additions & 4 deletions release.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,13 @@ Bump the version in `setup.py`

### Step 2) Push code

Make changes, commit and push. The build workflow starts automatically and builds the Docker image and wheels. The Docker image is automatically pushed to Dockerhub. The wheels need to be manually uploaded to PyPI as explained below.
Make changes, commit and push.

### Step 3) Create tag and release
### Step 3) Run build workflow

On GitHub go to the repo's "Actions" tab and manually trigger the "build" workflow. The build workflow builds the Docker image and wheels. The Docker image is automatically pushed to Dockerhub. The wheels need to be manually uploaded to PyPI as explained below.

### Step 4) Create tag and release

Now, create a tag with the same version just entered in the `setup.py` and push that tag to the remote.
```
Expand All @@ -18,7 +22,7 @@ git push origin vx.x.x

Then create a release on GitHub using this tag.

### Step 4) Upload wheels to PyPI
### Step 5) Upload wheels to PyPI

First, make sure you have the most recent version of twine installed on the host
```
Expand All @@ -30,7 +34,7 @@ Then, download and extract the wheels from the (successfully completed) workflow
python3 -m twine upload dist/*
```

#### Step 5) Tag Docker image with correct version
#### Step 6) Tag Docker image with correct version

When pushing changes, a Docker image `lubo1994/mv-extractor:dev` is being build and pushed to DockerHub. Upon a release, this image should be tagged with the correct release version and the `latest` tag. To this end, first pull the `dev` image
```
Expand Down

0 comments on commit 995ed82

Please sign in to comment.