Skip to content

Commit

Permalink
Update README.md with a description of auter (#2)
Browse files Browse the repository at this point in the history
* Update README.md with a description of auter
Bump version to 0.7
Update HACKING.md with instructions on tagging a release

* Updated README.md with where to find binaries / repositories
Fixed typo in HACKING.md
Fixed markdown in MAINTAINERS.md
  • Loading branch information
Beerey authored and Piers Cornwell committed Jul 7, 2016
1 parent 74d9414 commit f79ed44
Show file tree
Hide file tree
Showing 6 changed files with 41 additions and 7 deletions.
20 changes: 20 additions & 0 deletions HACKING.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,23 @@ auter --reboot
**Documentation**

When making any changes to code, make sure documentation (--help, man page) has been updated to reflect any changes

**Release Process**

1. Ensure that all files are updated to the version of the release number you're about to tag. This includes:
- auter
- auter.man
- NEWS
- auter.spec

2. Regenerate the man page using help2man:

# help2man --include=auter.help2man --no-info ./auter > auter.man

3. Add notes to auter.spec and NEWS with a list of the changes for this release

4. Push to github

5. Tag a release through github

6. Engage with the rpmbuilding process to get rpms built based on the new tab, and attach those to the github release.
4 changes: 4 additions & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
Project auter is maintained by the auter team. Bug reports & assistance
can be found at our email list:

```
[email protected]
```

Original authors at Rackspace (http://www.rackspace.co.uk):
```
- Cameron Beere
- Piers Cornwell
- Mike Frost
- Paolo Gigante
```
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# auter

Automatic updates for RHEL, CentOS or Fedora servers, with the ability to run pre/post hooks, pre-download packages & reboot after the updates.

**Enable/Disable**

Adds or removes a lockfile that auter will check the presence of to see whether to do anything:
Expand Down Expand Up @@ -49,3 +51,13 @@ You'll usually want everything to run via cron, but you can also run auter manua
auter --prep
auter --apply
```

**yum repo & binaries**

You can find rpm files attached to each auter release in github.

For a yum repo with pre-built binaries for each supported distribution, see our copr page:

```
https://copr.fedorainfracloud.org/coprs/piersc/auter/
```
2 changes: 1 addition & 1 deletion auter
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
#


readonly AUTERVERSION="0.6"
readonly AUTERVERSION="0.7"
readonly DATADIR="/var/lib/auter"
readonly LOCKFILE="${DATADIR}/enabled"
readonly PIDFILE="/var/run/auter/auter.pid"
Expand Down
8 changes: 3 additions & 5 deletions auter.man
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3.
.TH AUTER "1" "April 2016" "auter 0.5" "User Commands"
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4.
.TH AUTER "1" "July 2016" "auter 0.7" "User Commands"
.SH NAME
auter \- manual page for auter 0.5
auter \- manual page for auter 0.7
.SH SYNOPSIS
.B auter
[\fI\,--enable|--disable|--status\/\fR] [\fI\,--prep\/\fR] [\fI\,--apply\/\fR] [\fI\,--reboot\/\fR] [\fI\,--postreboot\/\fR] [\fI\,--config=<configfile>\/\fR] [\fI\,OPTION\/\fR]
Expand Down Expand Up @@ -128,5 +128,3 @@ Config options are set in /etc/auter/auter.conf, or in the file referenced by th

/var/lib/auter/last-update-CONFIGSET
This file contains the updates that were last applied by auter. The CONFIGSET part of the filename is defined in the auter config file by setting a variable of the same name, and if not defined is set to "default".
.SH "REPORTING BUGS"
Report bugs at <https://github.rackspace.com/IAW/auter>
2 changes: 1 addition & 1 deletion auter.spec
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name: auter
Version: 0.6
Version: 0.7
Release: 1%{?dist}
Summary: Prepare and apply updates

Expand Down

0 comments on commit f79ed44

Please sign in to comment.