@@ -15,28 +15,32 @@ It is a CLI tool that uses `docker/podman-compose` and [Pulp OCI Images](https:/
1515To set it up, follow these steps:
1616
1717``` bash
18- # 1. clone repos to the same basedir (pulpcore is required)
18+ # 1. clone required repos to the same basedir
1919git clone https://github.com/pulp/oci_env.git
2020git clone https://github.com/pulp/pulpcore.git
21+ git clone https://github.com/pulp/pulp-openapi-generator.git # required for 'generate-client' below
22+
23+ # 1.1 add more repos as necessary to the same basedir
2124git clone https://github.com/pulp/pulp_rpm.git
2225
2326# 2. install oci-env client
2427cd oci_env
2528pip3 install -e client
2629
2730# 3. use minimal compose.env
31+ # At least add pulpcore to DEV_SOURCE_PATH like this: DEV_SOURCE_PATH=pulpcore
2832cp compose.env.example compose.env
2933
30- # 4. build the images and do basic setup
34+ # 4. build the images and start the service
3135oci-env compose build
36+ oci-env compose up
37+
38+ # 5. do basic setup
3239oci-env generate-client -i
3340oci-env generate-client -i pulp_file
34-
35- # 5. start the service
36- oci-env compose up
3741```
3842
39- A more comprehensive guide on setting up the dev environment is documented [ here] ( # ) .
43+ A more comprehensive guide on setting up the dev environment is documented [ here] ( site:oci_env/docs/dev/tutorials/quickstart/ ) .
4044
4145### 2. Make and test changes
4246
@@ -52,11 +56,11 @@ oci-env test -i -p pulp_rpm functional
5256oci-env test -p pulp_rpm functional -k test_mychages
5357```
5458
55- A more comprehensive guide on running tests is documented [ here] ( # ) .
59+ A more comprehensive guide on running tests is documented [ here] ( site:oci_env/docs/dev/guides/run-tests/ ) .
5660
5761### 3. Update the changelog entry
5862
59- Pulp uses [ towncrier] ( # ) to manage its changelog.
63+ Pulp uses [ towncrier] ( https://towncrier.readthedocs.io/en/stable/ ) to manage its changelog.
6064
6165It requires that you have a related GitHub issue number, except for trivial changes (such as typo fixes).
6266In those cases the entry is no required at all.
@@ -83,7 +87,7 @@ The changelog message should use past simple tense and describe the change being
8387 echo "Added API that allows users to export a repository version to disk." > CHANGES/plugin_api/3245.feature
8488 ```
8589
86- A more comprehensive guide on using towncrier in the Pulp project is documented [ here] ( # ) .
90+ A more comprehensive guide on using towncrier in the Pulp project is documented [ here] ( site:pulpcore/docs/dev/guides/git/#changelog-update ) .
8791
8892### 4. Commit and Submit a PR
8993
@@ -108,4 +112,4 @@ the worker configuration.
108112closes #1392
109113```
110114
111- A more comprehensive guide on using git in the Pulp project is documented [ here] ( # ) .
115+ A more comprehensive guide on using git in the Pulp project is documented [ here] ( site:pulpcore/docs/dev/guides/git/ ) .
0 commit comments