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
You can see the [full history of the Python API on the documentation site](http://developer.shotgridsoftware.com/python-api/changelog.html).
27
28
28
-
## Updating HTTPLib2
29
-
30
-
The API comes with a copy of the `httplib2` inside the `shotgun_api3/lib` folder. To update the copy to a more recent version of the API, you can run the `update_httplib2.py` script at the root of this repository like this:
31
-
32
-
python update_httplib2.py vX.Y.Z
33
-
34
-
where `vX.Y.Z` is a release found on `httplib2`'s [release page](https://github.com/httplib2/httplib2/releases).
35
29
36
30
## Tests
37
31
@@ -47,38 +41,3 @@ Integration and unit tests are provided.
47
41
-`test_client` and `tests_unit` use mock server interaction and do not require a Flow Production Tracking instance to be available (no modifications to `tests/config` are necessary).
48
42
-`test_api` and `test_api_long`*do* require a Flow Production Tracking instance, with a script key available for the tests. The server and script user values must be supplied in the `tests/config` file. The tests will add test data to your server based on information in your config. This data will be manipulated by the tests, and should not be used for other purposes.
49
43
- To run all of the tests, use the shell script `run-tests`.
50
-
51
-
## Release process
52
-
53
-
### Packaging up new release
54
-
55
-
1) Update the Changelog in the `HISTORY.rst` file
56
-
- Add bullet points for any changes that have happened since the previous release. This may include changes you did not make so look at the commit history and make sure we don't miss anything. If you notice something was done that wasn't added to the changelog, hunt down that engineer and make them feel guilty for not doing so. This is a required step in making changes to the API.
57
-
- Try and match the language of previous change log messages. We want to keep a consistent voice.
58
-
- Make sure the date of the release matches today. We try and keep this TBD until we're ready to do a release so it's easy to catch that it needs to be updated.
59
-
- Make sure the version number is filled out and correct. We follow semantic versioning.
60
-
2) Ensure any changes or additions to public methods are documented
61
-
- Ensure that doc strings are updated in the code itself to work with Sphinx and are correctly formatted.
62
-
- Examples are always good especially if this a new feature or method.
63
-
- Think about a new user to the API trying to figure out how to use the features you're documenting.
64
-
3) Update the version value in `python-api/setup.py` to match the version you are packaging. This controls what version users will get when installing via pip.
65
-
4) Update the `__version__` value in `shotgun_api3/shotgun.py` to the version you're releasing. This identified the current version within the API itself.
66
-
5) Commit these changes in master with a commit message like `packaging for the vx.x.x release`.
67
-
6) Create a tag based off of the master branch called `vx.x.x` to match the version number you're releasing.
68
-
7) Push master and your tag to Github.
69
-
8) Update the Releases page with your new release.
70
-
- The release should already be there from your tag but if not, create a new one.
71
-
- Add more detailed information regarding the changes in this release. This is a great place to add examples, and reasons for the change!
72
-
73
-
### Letting the world know
74
-
Post a message in the [Pipeline Community channel](https://community.shotgridsoftware.com/c/pipeline).
75
-
76
-
### Prepare for the Next Dev Cycle
77
-
1) Update the `__version__` value in `shotgun_api3/shotgun.py` to the next version number with `.dev` appended to it. For example, `v3.0.24.dev`
78
-
2) Add a new section to the Changelog in the `HISTORY.rst` file with the next version number and a TBD date
79
-
```
80
-
**v3.0.24 - TBD**
81
-
+ TBD
82
-
```
83
-
3) Commit the changes to master with a commit message like `Bump version to v3.0.24.dev`
The API comes with a copy of the `httplib2` inside the `shotgun_api3/lib` folder. To update the copy to a more recent version of the API, you can run the `update_httplib2.py` script at the root of this repository like this:
5
+
6
+
python update_httplib2.py vX.Y.Z
7
+
8
+
where `vX.Y.Z` is a release found on `httplib2`'s [release page](https://github.com/httplib2/httplib2/releases).
9
+
10
+
11
+
# Release process
12
+
13
+
## Packaging up new release
14
+
15
+
1) Update the Changelog in the `HISTORY.rst` file
16
+
- Add bullet points for any changes that have happened since the previous release. This may include changes you did not make so look at the commit history and make sure we don't miss anything. If you notice something was done that wasn't added to the changelog, hunt down that engineer and make them feel guilty for not doing so. This is a required step in making changes to the API.
17
+
- Try and match the language of previous change log messages. We want to keep a consistent voice.
18
+
- Make sure the date of the release matches today. We try and keep this TBD until we're ready to do a release so it's easy to catch that it needs to be updated.
19
+
- Make sure the version number is filled out and correct. We follow semantic versioning.
20
+
2) Ensure any changes or additions to public methods are documented
21
+
- Ensure that doc strings are updated in the code itself to work with Sphinx and are correctly formatted.
22
+
- Examples are always good especially if this a new feature or method.
23
+
- Think about a new user to the API trying to figure out how to use the features you're documenting.
24
+
3) Update the version value in `python-api/setup.py` to match the version you are packaging. This controls what version users will get when installing via pip.
25
+
4) Update the `__version__` value in `shotgun_api3/shotgun.py` to the version you're releasing. This identifies the current version within the API itself.
26
+
5) Commit these changes in master with a commit message like `packaging for the vx.x.x release`.
27
+
6) Create a tag based off of the master branch called `vx.x.x` to match the version number you're releasing.
28
+
7) Push master and your tag to Github.
29
+
8) Update the Releases page with your new release.
30
+
- The release should already be there from your tag but if not, create a new one.
31
+
- Add more detailed information regarding the changes in this release. This is a great place to add examples, and reasons for the change!
32
+
33
+
## Letting the world know
34
+
Post a message in the [Pipeline Community channel](https://community.shotgridsoftware.com/c/pipeline).
35
+
36
+
## Prepare for the Next Dev Cycle
37
+
1) Update the `__version__` value in `shotgun_api3/shotgun.py` to the next version number with `.dev` appended to it. For example, `v3.0.24.dev`
38
+
2) Add a new section to the Changelog in the `HISTORY.rst` file with the next version number and a TBD date
39
+
```
40
+
**v3.0.24 - TBD**
41
+
+ TBD
42
+
```
43
+
3) Commit the changes to master with a commit message like `Bump version to v3.0.24.dev`
0 commit comments