You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-8
Original file line number
Diff line number
Diff line change
@@ -73,27 +73,28 @@ To run pre-commit checks:
73
73
74
74
#### Publishing
75
75
76
-
Please remember to sync your updated dependecies to setup.py with :
76
+
Increment the version in `setup.py`. As soon as your PR is merged to main, a new `koku-nise` package will built, tagged, and deployed to PyPI.
77
77
78
-
pipenv-setup sync -p
78
+
##### Finer Publishing Details
79
79
80
-
After that, make sure to increment the version in setup.py. As soon as your PR is merged to main, a new koku-nise package will built, tagged, and deployed to PyPI.
80
+
All of the deployment is driven entirely by a Github Action workflow, so if issues ever crop up, start in `publish-to-pypi.yml`. When a branch is merged into `main`, the Action will kick off. There are two things that must happen before a deployment is successful:
81
81
82
-
##### Finer Publishing Details
82
+
1. A successful artifact build
83
+
2. The tag must not yet exist in `git`.
83
84
84
-
All of the deployment is driven entirely by a Github Action workflow, so if issues ever crop up, start in `publish-to-pypi.yml`. When a branch is merged into main, the Action will kick off. There are three things that must happen before a deployment is successful, a successful artifact build, dependencies verified in sync between the requirements files, and setup.py, and the tag must not yet exist in git. The dependency syncing/verification is done with the [pipenv-setup](https://github.com/Madoshakalaka/pipenv-setup) tool. After the artifact is deployed, it\'ll be available at [PyPI](https://pypi.org/project/koku-nise/#history).
85
+
After the artifact is deployed, it'll be available at [PyPI](https://pypi.org/project/koku-nise/#history).
85
86
86
87
#### Nise, Koku, and IQE Integration
87
88
88
-
The iqe tests use nise to generate mock data; therefore, we need to ensure that our nise changes do not break the iqe tests. To do this you will need to copy `.env.example` to `.env` and customize as necessary. After the `.env` file is configured you will then need to run
89
+
The IQE tests use nise to generate mock data; therefore, we need to ensure that our nise changes do not break the IQE tests. To do this you will need to copy `.env.example` to `.env` and customize as necessary. After the `.env` file is configured you will then need to run
89
90
90
91
make run-iqe
91
92
92
-
The `make run-iqe` command by default will run the smoke tests. However, if you want to run a specific iqe test command you can pass it in through the `IQE_CMD` parameter
93
+
The `make run-iqe` command by default will run the smoke tests. However, if you want to run a specific IQE test command you can pass it in through the `IQE_CMD` parameter
93
94
94
95
make run-iqe IQE_CMD='iqe tests plugin hccm -k test_api_aws_provider_create_foo_resource_name'
95
96
96
-
### Prereqs
97
+
### Prerequisites
97
98
98
99
- AWS population requires prior setup of AWS Cost and Usage Report of same name to be created, as well as associated Bucket, Policy, Role, etc.
0 commit comments