ReleaseProcess: Difference between revisions

From GNU MediaGoblin Wiki
Jump to navigation Jump to search
(added pypi, fixing version numbers and announcement steps)
(updating release process)
Line 3: Line 3:
Here's the list of steps to do a release.
Here's the list of steps to do a release.


'''1. verify with others on IRC that we're good to go'''
# Verify with others on IRC that we're good to go.
# Do a <tt>git fetch</tt> and make sure you have the latest code.

# Run the unit tests: {{Cmd|./runtests.sh}} If any tests fail, proceed no further!

# Update version numbers in <pre>mediaboglin/_version.py</pre> and <pre>docs/conf.py</pre>.
'''2. do a <tt>git fetch</tt> and make sure you have the latest code'''
# Tag: {{Cmd|git tag -a vX.Y.Z}}

# Generate documentation. {{Cmd|./generatedocs.sh}}

# Build the tarfile. {{Cmd|./maketarball.sh -r vX.Y.Z}}
'''3. run the unit tests:'''
# Push the tarball to the site '''FIXME - need to set this up'''

# Update sites: PYPI, etc '''FIXME - need to set this up'''
<pre>
# Update version numbers in git: <pre>mediagoblin/_version.py</pre> and <pre>docs/conf.py</pre>
./runtests.sh
# Announce the release
</pre>

If any tests fail, proceed no further!


'''4. update version numbers'''

# setup.py
# docs/conf.py


'''5. tag'''

<pre>
git tag -a vX.Y.Z
</pre>


'''6. generate documentation'''

FIXME - this step needs more work

<pre>
./generatedocs.sh
</pre>


'''7. build the tarfile'''

FIXME - this step needs to incorporate the generated docs above; probably need to add an optional argument to maketarball.sh that takes a directory of stuff to add to the tarball after it's been created.

<pre>
./maketarball.sh <TAG>
</pre>


'''8. push the tarball to the site'''

FIXME - we need to set this up


'''9. update PYPI'''

FIXME - need instructions, accounts, etc


'''10. update version numbers in git'''

# setup.py
# docs/conf.py


'''11. announce the release'''

Revision as of 01:07, 2 September 2011

Release Process

Here's the list of steps to do a release.

  1. Verify with others on IRC that we're good to go.
  2. Do a git fetch and make sure you have the latest code.
  3. Run the unit tests: ./runtests.sh If any tests fail, proceed no further!
  4. Update version numbers in
    mediaboglin/_version.py
    and
    docs/conf.py
    .
  5. Tag: git tag -a vX.Y.Z
  6. Generate documentation. ./generatedocs.sh
  7. Build the tarfile. ./maketarball.sh -r vX.Y.Z
  8. Push the tarball to the site FIXME - need to set this up
  9. Update sites: PYPI, etc FIXME - need to set this up
  10. Update version numbers in git:
    mediagoblin/_version.py
    and
    docs/conf.py
  11. Announce the release