2018-01-26 06:26:36 +01:00
|
|
|
# Release process
|
|
|
|
|
|
|
|
Here's information on how to release an update to flawfinder.
|
|
|
|
|
|
|
|
## Changing version number
|
|
|
|
|
|
|
|
You should really change the version number before changing anything else.
|
|
|
|
Make sure every release has a unique version number.
|
|
|
|
|
|
|
|
To change version number, edit the following files:
|
|
|
|
makefile
|
|
|
|
flawfinder
|
|
|
|
flawfinder.spec
|
|
|
|
setup.py
|
|
|
|
index.html
|
|
|
|
|
|
|
|
Then run:
|
2018-03-16 05:55:00 +01:00
|
|
|
`make test && make test-is-correct` # update version number in tests
|
2018-01-26 06:26:36 +01:00
|
|
|
|
|
|
|
## Test it
|
|
|
|
|
2018-03-16 05:55:00 +01:00
|
|
|
`make check` # Run tests in Python 2 and 3
|
2018-01-26 06:26:36 +01:00
|
|
|
|
|
|
|
## Tag version
|
|
|
|
|
|
|
|
Once you're sure this is the *real* version, tag it:
|
|
|
|
|
2018-03-16 05:55:00 +01:00
|
|
|
`git tag VERSION`
|
2018-10-01 02:35:03 +02:00
|
|
|
`git push --tags`
|
2018-01-26 06:26:36 +01:00
|
|
|
|
|
|
|
## Create tarball
|
|
|
|
|
|
|
|
Run:
|
2018-03-16 05:55:00 +01:00
|
|
|
`make distribute`
|
2018-01-26 06:26:36 +01:00
|
|
|
|
|
|
|
|
|
|
|
## Post tarball
|
|
|
|
|
|
|
|
Then post the tarball flawfinder-VERSION.tar.gz to
|
|
|
|
the usual places:
|
|
|
|
|
|
|
|
* SourceForge "files" directory, and set it to be the default download.
|
|
|
|
* dwheeler.com/flawfinder
|
|
|
|
|
|
|
|
## Post to pip
|
|
|
|
|
|
|
|
Create a PyPi distribution package:
|
|
|
|
|
2018-03-16 05:55:00 +01:00
|
|
|
`make pypi`
|
2018-01-26 06:26:36 +01:00
|
|
|
|
|
|
|
And upload it:
|
|
|
|
|
2018-03-16 05:55:00 +01:00
|
|
|
`make upload-pypi`
|