Browse Source

doc: updated Developers Guide.

pull/297/head
Vladimír Vondruš 8 years ago
parent
commit
e1c4a88bf7
  1. 29
      doc/developers.dox

29
doc/developers.dox

@ -843,12 +843,15 @@ inverse.
all tools and examples still behave properly all tools and examples still behave properly
10. Build and upload public docs (see @ref developers-documentation), verify 10. Build and upload public docs (see @ref developers-documentation), verify
that there are no new warnings and the changelog looks correct that there are no new warnings and the changelog looks correct
11. Push all new changes to a temporary branch (e.g., `next`) 11. Push all new changes to a temporary branch (e.g., `next`), don't forget the
`ports` branch in examples
12. Wait for the CIs to get green 12. Wait for the CIs to get green
13. Tag a new version using @cb{.sh} git tag -a v20XY.ab @ce, say just 13. Tag a new version using @cb{.sh} git tag -a v20XY.ab @ce, say just
`Version 20XY.ab` as a message `Version 20XY.ab` as a message
14. Push the tag, verify that the CIs are still green 14. Push the tag, verify that the CIs are still green
15. Write a release announcement for the blog 15. Update the Corrade and Magnum tagfiles on the website using the
freshly-built *public* docs
16. Write a release announcement for the blog
- highlight the most prominent features, mention detailed blog posts - highlight the most prominent features, mention detailed blog posts
about them, if any about them, if any
- reference detailed changelogs for all projects at the end - reference detailed changelogs for all projects at the end
@ -856,8 +859,8 @@ inverse.
- create some fancy eye-catchy cover image featuring nice screenshots of - create some fancy eye-catchy cover image featuring nice screenshots of
new functionality new functionality
- add release annoucement link under the button on front page - add release annoucement link under the button on front page
16. Publish the release announcement, verify it looks correct 17. Publish the release announcement, verify it looks correct
17. Advertise the release announcement, preferrably Monday 5 PM, never Friday 18. Advertise the release announcement, preferrably Monday 5 PM, never Friday
or weekends or weekends
- come up with some 100-character-long extended title - come up with some 100-character-long extended title
- Twitter (extended title + url and some hashtags), first dry-run the - Twitter (extended title + url and some hashtags), first dry-run the
@ -871,9 +874,9 @@ inverse.
and submit that to Khronos and submit that to Khronos
- Add a message to the Gitter chat (title as heading, cover image, - Add a message to the Gitter chat (title as heading, cover image,
summary in a blockquote and "read more" link) summary in a blockquote and "read more" link)
18. Reference Twitter, Reddit, Hacker News and mailing list in a "Discussion" 19. Reference Twitter, Reddit, Hacker News and mailing list in a "Discussion"
note at the end of the article, reupload that change note at the end of the article, reupload that change
19. Update versions of ArchLinux AUR packages: 20. Update versions of ArchLinux AUR packages:
- run `makepkg` in `package/archlinux/magnum*-git`, verify it builds and - run `makepkg` in `package/archlinux/magnum*-git`, verify it builds and
says correct version, ideally with `r0` at the ennd says correct version, ideally with `r0` at the ennd
- copy the updated `PKGBUILD` to the AUR package repo, run - copy the updated `PKGBUILD` to the AUR package repo, run
@ -881,15 +884,15 @@ inverse.
- commit the updated `PKGBUILD` and `.SRCINFO`, push - commit the updated `PKGBUILD` and `.SRCINFO`, push
- after pushing all, verify that the version is updated in the AUR web - after pushing all, verify that the version is updated in the AUR web
interface as well interface as well
20. Update Debian package changelog in `package/debian/changelog`, copypasting 21. Update Debian package changelog in `package/debian/changelog`, copypasting
the last entry, updating it and using the Git tag date+time for it (note the last entry, updating it and using the Git tag date+time for it (note
that the date format is slightly different) that the date format is slightly different)
21. Update Homebrew package versions 22. Update Homebrew package versions
22. Ask someone to update the Ubuntu PPA 23. Ask someone to update the Ubuntu PPA
23. Ask someone to update Vcpkg packages 24. Ask someone to update Vcpkg packages
24. Close the 20XY.ab GitHub milestone 25. Close the 20XY.ab GitHub milestone
25. Add link to the release notes to the tag on GitHub 26. Add link to the release notes to the tag on GitHub
26. Have a drink and take two days off 27. Have a drink and take two days off
*/ */
} }

Loading…
Cancel
Save