Skip to content

Commit c604480

Browse files
committed
Updating README.rst with release instructions.
1 parent e93c5b2 commit c604480

File tree

1 file changed

+55
-5
lines changed

1 file changed

+55
-5
lines changed

README.rst

+55-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
pygame.org website |build-status| |coverage-status|
22
===================================================
33

4-
Pieces of the pygame website will be open sourced here.
4+
Pieces of the pygame website (https://www.pygame.org/) will be open sourced here.
55

66
Strategy is to bring in code one piece at a time, and clean it up as I go.
77

88

9+
It's a community website where people can post projects, comment on them,
10+
but also write things in there themselves on wiki pages.
11+
12+
913
Contributing
1014
============
1115

@@ -233,14 +237,16 @@ With with a @cache decorator, and/or markup in a template.
233237
Releases
234238
========
235239

236-
Releases are done from travisci. Fairly closely following this:
237-
https://docs.travis-ci.com/user/deployment/pypi/
240+
Step by step release instructions below.
238241

239242
- Commits to `master` branch do a dev deploy to pypi.
240243
- Commits to `mastertest` branch do a dev deploy to pypi.
241244
- Commits to a tag do a real deploy to pypi.
242245

243246

247+
Prereleases
248+
-----------
249+
244250
https://packaging.python.org/tutorials/distributing-packages/#pre-release-versioning
245251

246252
Pre releases should be named like this:
@@ -252,8 +258,52 @@ Which is one version ahead of of the last tagged release.
252258

253259
Release tags should be like '0.0.2', and match the `pygameweb/__init__.py __version__`.
254260

255-
When everything is ready, tags should be done through github.
256261

257-
Note: do not tag pre releases (these are made on commits to `master`/`mastertest`).
262+
Preparing a release in a branch.
263+
--------------------------------
264+
265+
It's a good idea to start a branch first, and make any necessary changes
266+
for the release.
267+
268+
```
269+
git checkout -b v0.0.2
270+
vi pygameweb/__init__.py __version__ = '0.0.2'
271+
git commit -m "Version 0.0.2"
272+
```
273+
274+
Change log, drafting a release.
275+
-------------------------------
276+
277+
Github 'releases' are done as well.
278+
You can start drafting the release notes in there before the tag.
258279
https://help.github.com/articles/creating-releases/
259280

281+
You can make the release notes with the help of the changes since last release.
282+
https://github.com/pygame/pygameweb/compare/0.0.1...master
283+
284+
git log 0.0.1...master
285+
286+
Tagging a release
287+
-----------------
288+
289+
When the release is tagged, pushing it starts the deploy to pypi off.
290+
```
291+
git tag -a 0.0.2
292+
git push origin 0.0.2
293+
```
294+
Note: do not tag pre releases
295+
(these are made on commits to `master`/`mastertest`).
296+
297+
After the tag is pushed, then you can do the release
298+
in github from your draft release.
299+
300+
301+
Back to dev version.
302+
--------------------
303+
304+
If we were at 0.0.2 before, now we want to be at 0.0.3.dev
305+
```
306+
vi pygameweb/__init__.py __version__ = '0.0.3.dev'
307+
```
308+
309+
Merge the release branch into master, and push that up.

0 commit comments

Comments
 (0)