diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/RELEASING | 44 | ||||
| -rw-r--r-- | doc/developer-guidelines.sgml | 9 |
2 files changed, 18 insertions, 35 deletions
diff --git a/doc/RELEASING b/doc/RELEASING index 1eaec9de..30c81ccf 100644 --- a/doc/RELEASING +++ b/doc/RELEASING | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | NOTES ON RELEASING NEW VERSION OF NAGIOSPLUG | 1 | NOTES ON RELEASING NEW VERSION OF MONITORING-PLUGINS |
| 2 | 2 | ||
| 3 | *** Pre-release | 3 | *** Pre-release |
| 4 | git pull | 4 | git pull |
| @@ -6,55 +6,33 @@ git pull | |||
| 6 | check compilation, check tinderbox screens | 6 | check compilation, check tinderbox screens |
| 7 | 7 | ||
| 8 | *** Prepare and commit files | 8 | *** Prepare and commit files |
| 9 | Update BUGS, NEWS file | 9 | Update NEWS file |
| 10 | Update AUTHORS if new members | 10 | Update AUTHORS if new members |
| 11 | Update configure.in, package.def and NP-VERSION-GEN with version | 11 | Update configure.ac and NP-VERSION-GEN with version |
| 12 | Run git2cl (get from http://josefsson.org/git2cl/): | 12 | commit NEWS configure.ac NP-VERSION-GEN |
| 13 | git2cl >Changelog | ||
| 14 | commit BUGS NEWS configure.in package.def ChangeLog | ||
| 15 | 13 | ||
| 16 | *** Create new annotated tag | 14 | *** Create new annotated tag |
| 17 | git tag -a release-1.4.14 -m release-1.4.14 | 15 | git tag -a v2.1.1 -m v2.1.1 |
| 18 | 16 | ||
| 19 | *** Push the code and tag to origin | 17 | *** Push the code and tag to origin |
| 20 | git push origin master | 18 | git push origin master |
| 21 | git push origin release-1.4.14 | 19 | git push origin v2.1.1 |
| 22 | 20 | ||
| 23 | *** Checkout new version | 21 | *** Checkout new version |
| 24 | rm -fr /tmp/monitoringlug | 22 | rm -fr /tmp/monitoringplug |
| 25 | # If you need to checkout the tag, don't forget to "checkout master" later to | 23 | # If you need to checkout the tag, don't forget to "checkout master" later to |
| 26 | # get back to your development branch: | 24 | # get back to your development branch: |
| 27 | git checkout tags/release-1.4.14 | 25 | git checkout tags/v2.1.1 |
| 28 | # Beware: the trailing slash of --prefix is REQUIRED | 26 | # Beware: the trailing slash of --prefix is REQUIRED |
| 29 | git checkout-index --prefix=/tmp/monitoringlug/ -a | 27 | git checkout-index --prefix=/tmp/monitoringplug/ -a |
| 30 | 28 | ||
| 31 | *** Build the tarball | 29 | *** Build the tarball |
| 32 | cd /tmp/monitoringlug | 30 | cd /tmp/monitoringplug |
| 33 | tools/setup | 31 | tools/setup |
| 34 | ./configure | 32 | ./configure |
| 35 | make dist | 33 | make dist |
| 36 | 34 | ||
| 37 | *** Upload generated tarball to sourceforge | 35 | *** Upload generated tarball to our Project Site |
| 38 | sftp frs.sourceforge.net | ||
| 39 | SF username and password | ||
| 40 | cd /uploads | ||
| 41 | put file | ||
| 42 | |||
| 43 | SF -> Submit News about release. Make sure it is called "Monitoring Plugins" (with those caps) | ||
| 44 | Link to download at http://sourceforge.net/project/showfiles.php?group_id=29880 | ||
| 45 | Include contents of NEWS for this release | ||
| 46 | List all people on team involved. | ||
| 47 | Add acknowledgement to contributors | ||
| 48 | Submit. Get URL to news item | ||
| 49 | |||
| 50 | SF -> Admin -> File Releases | ||
| 51 | Add a release to nagiosplug and create a file release | ||
| 52 | Name: 1.4.14 | ||
| 53 | Create release | ||
| 54 | Step 1: Add release notes pointing to news item | ||
| 55 | Step 2: add file | ||
| 56 | Step 3: *.tar.gz, Platform Independent, Source .gz | ||
| 57 | Step 4: Send notice | ||
| 58 | 36 | ||
| 59 | *** Announce new release | 37 | *** Announce new release |
| 60 | Send email to help, announce with the news text | 38 | Send email to help, announce with the news text |
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml index d9340285..228d3fa1 100644 --- a/doc/developer-guidelines.sgml +++ b/doc/developer-guidelines.sgml | |||
| @@ -194,13 +194,15 @@ | |||
| 194 | <row> | 194 | <row> |
| 195 | <entry align="center"><para>3</para></entry> | 195 | <entry align="center"><para>3</para></entry> |
| 196 | <entry valign="middle"><para>Unknown</para></entry> | 196 | <entry valign="middle"><para>Unknown</para></entry> |
| 197 | <entry><para>Invalid command line arguments were supplied to the | 197 | <entry><para>Invalid command line arguments were supplied to the |
| 198 | plugin or low-level failures internal to the plugin (such as unable to fork, | 198 | plugin or low-level failures internal to the plugin (such as unable to fork, |
| 199 | or open a tcp socket) that prevent it from performing the specified | 199 | or open a tcp socket) that prevent it from performing the specified |
| 200 | operation. Higher-level errors (such as name resolution errors, | 200 | operation. Higher-level errors (such as name resolution errors, |
| 201 | socket timeouts, etc) are outside of the control of plugins and should | 201 | socket timeouts, etc) are outside of the control of plugins and should |
| 202 | generally NOT be reported as UNKNOWN states. | 202 | generally NOT be reported as UNKNOWN states. |
| 203 | </para></entry> | 203 | </para> |
| 204 | <para>The --help or --version output should also result in Unknown state.</para> | ||
| 205 | </entry> | ||
| 204 | </row> | 206 | </row> |
| 205 | </tbody> | 207 | </tbody> |
| 206 | </tgroup> | 208 | </tgroup> |
| @@ -610,6 +612,9 @@ | |||
| 610 | <para>The option -v or --verbose should be present in all plugins. | 612 | <para>The option -v or --verbose should be present in all plugins. |
| 611 | The user should be allowed to specify -v multiple times to increase | 613 | The user should be allowed to specify -v multiple times to increase |
| 612 | the verbosity level, as described in <xref linkend="verboselevels">.</para> | 614 | the verbosity level, as described in <xref linkend="verboselevels">.</para> |
| 615 | |||
| 616 | The exit code for version information or help should be UNKNOWN | ||
| 617 | (3).</para> | ||
| 613 | </section> | 618 | </section> |
| 614 | 619 | ||
| 615 | <section> | 620 | <section> |
