Skip to content

Commit a670b0f

Browse files
committed
update setup instruction
1 parent d1b6424 commit a670b0f

2 files changed

Lines changed: 25 additions & 13 deletions

File tree

.github/README.md

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

.github/setup.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
How to Update
2+
=============
3+
4+
1. Update nlopt submodule
5+
```shell
6+
git submodule update --remote
7+
# if there are changes
8+
git add extern/
9+
git commit -m "Update nlopt submodule"
10+
```
11+
2. `[Optional]` If there is a need, update the `ci/nlopt_manylinux2014_x64_64.Dockerfile` image. This is used to build
12+
the linux images
13+
* This should be done in `image/*` branch as the github action `manylinux-image.yml` will automatically update the
14+
image in dockerhub on push.
15+
3. Update `.github/workflows/build.yaml` if necessary
16+
4. There are already tests in the github workflows to test that `pip install nlopt` works. But none to test the module specifically
17+
1. Spin up a docker image and run the sample code
18+
2. ```shell
19+
docker container run -it --rm --entrypoint bash python:3.10-slim-buster
20+
pip install nlopt
21+
apt-get update
22+
apt-get install curl -y
23+
curl https://raw.githubusercontent.com/DanielBok/nlopt-python/master/test_scripts/sample_test_script.py --output test.py
24+
python test.py
25+
```

0 commit comments

Comments
 (0)