Browse Source

Update documentation after final release review

master
Peter J. Jones 2 years ago
parent
commit
8f2eb540d7
Signed by: Peter Jones <pjones@devalot.com> GPG Key ID: 9DAFAA8D01941E49
6 changed files with 89 additions and 19 deletions
  1. 0
    2
      CHANGES.md
  2. 83
    0
      MAINTAINERS.md
  3. 4
    2
      README.md
  4. 0
    14
      TODO
  5. 1
    0
      cabal.project
  6. 1
    1
      xmonad.cabal

+ 0
- 2
CHANGES.md View File

@@ -69,8 +69,6 @@
Fixes #8. (Second way to have a custom build environment for
XMonad. See previous entry for another solution.)

* Fixed a crash related to an unhandled getWindowAttributes exception

## 0.12 (December 14, 2015)

* Compiles with GHC 7.10.2, 7.8.4, and 7.6.3

+ 83
- 0
MAINTAINERS.md View File

@@ -0,0 +1,83 @@
# XMonad Maintainers

## The XMonad Core Team

* Adam Vogt [GitHub][aavogt]

* Brandon S Allbery [GitHub][geekosaur], IRC: `geekosaur`

* Brent Yorgey [GitHub][byorgey], IRC: `byorgey`

* Daniel Wagner [GitHub][dmwit], IRC: `dmwit`

* David Lazar [GitHub][davidlazar]

* Devin Mullins [GitHub][twifkak]

* Peter J. Jones [GitHub][pjones], [Twitter][twitter:pjones], [OpenPGP Key][pgp:pjones], IRC: `pmade`

## Release Procedures

When the time comes to release another version of XMonad and Contrib...

1. Create a release branch (e.g., `release-0.XX`).

This will allow you to separate the release process from main
development. Changes you make on this branch will be merged back
into `master` as one of the last steps.

2. Update the version number in the `*.cabal` files and verify
dependencies and documentation. This includes the `tested-with:`
field.

3. Use the [packdeps][] tool to ensure you have the dependency
versions correct. If you need to update the version of a
dependency then you should rebuild and retest.

4. Review documentation files and make sure they are accurate:

- `README.md`
- `CHANGES.md`
- and the `example-config.hs` in the `xmonad-testing` repo

5. Generate the manpage:

* `cabal configure` with the `-fgeneratemanpage` flag
* Build the project
* Run the `generatemanpage` tool from the top level of this repo
* Review the man page: `man -l man/xmonad.1`

6. Tag the repository with the release version (e.g., `v0.13`)

7. Build the project tarballs (`cabal sdist`)

8. Upload the packages to Hackage (`cabal upload`)

9. Merge the release branches into `master`

10. Update the website:

* Generate and push haddocks with `xmonad-web/gen-docs.sh`

* Check that `tour.html` and `intro.html` are up to date, and
mention all core bindings

11. Update the topic for the IRC channel (`#xmonad`)

12. Send the `announce-0.XX.txt` file to:

- XMonad mailing list
- Haskell Cafe

[packdeps]: http://hackage.haskell.org/package/packdeps

[aavogt]: https://github.com/orgs/xmonad/people/aavogt
[geekosaur]: https://github.com/orgs/xmonad/people/geekosaur
[byorgey]: https://github.com/orgs/xmonad/people/byorgey
[dmwit]: https://github.com/orgs/xmonad/people/dmwit
[davidlazar]: https://github.com/orgs/xmonad/people/davidlazar
[twifkak]: https://github.com/orgs/xmonad/people/twifkak

[pjones]: https://github.com/orgs/xmonad/people/pjones
[twitter:pjones]: https://twitter.com/contextualdev
[pgp:pjones]: http://pgp.mit.edu/pks/lookup?op=get&search=0x526722D1204284CB

+ 4
- 2
README.md View File

@@ -64,7 +64,7 @@ We'll now walk through the complete list of toolchain dependencies.

## Running xmonad

Add:
If you built XMonad using `cabal` then add:

exec $HOME/.cabal/bin/xmonad

@@ -72,7 +72,7 @@ to the last line of your `.xsession` or `.xinitrc` file.

## Configuring

See the `CONFIG` document.
See the [CONFIG][] document and the [example configuration file][example-config].

## XMonadContrib

@@ -117,3 +117,5 @@ For a program dispatch menu:
[xmonadcontrib]: https://hackage.haskell.org/package/xmonad-contrib
[xmc-prompt-shell]: https://hackage.haskell.org/package/xmonad-contrib/docs/XMonad-Prompt-Shell.html
[platform]: http://haskell.org/platform/
[example-config]: https://github.com/xmonad/xmonad-testing/blob/master/example-config.hs
[config]: https://github.com/xmonad/xmonad/blob/master/CONFIG

+ 0
- 14
TODO View File

@@ -1,14 +0,0 @@
= Release management =

* generate, and push website haddocks with xmonad-web/gen-docs.sh
* generate manpage, generate html manpage
* double check README build instructions
* bump xmonad.cabal version and X11 version
* update cabal "tested-with:" fields
* upload X11 and xmonad to Hackage
* update #xmonad topic
* check examples/text in user-facing Config.hs
* check tour.html and intro.html are up to date, and mention all core bindings
* confirm template config is type correct
* update haskellwiki notable changes since x.x
* email announce

+ 1
- 0
cabal.project View File

@@ -0,0 +1 @@
packages: ./

+ 1
- 1
xmonad.cabal View File

@@ -17,7 +17,7 @@ license: BSD3
license-file: LICENSE
author: Spencer Janssen
maintainer: xmonad@haskell.org
extra-source-files: README.md CHANGES.md TODO CONFIG STYLE
extra-source-files: README.md CHANGES.md CONFIG STYLE
tests/*.hs
tests/Properties/*.hs
tests/Properties/Layout/*.hs

Loading…
Cancel
Save