Skip to content

Commit

Permalink
Merge pull request #60 from dotse/develop
Browse files Browse the repository at this point in the history
Merge 1.1.1 to master
  • Loading branch information
mattias-p authored Nov 2, 2017
2 parents 50b6ac9 + cceae78 commit 6573f12
Show file tree
Hide file tree
Showing 18 changed files with 258 additions and 139 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@ _build/
cover_db/
blib/
inc/
share/locale/
.lwpcookies
.last_cover_stats
nytprof.out
pod2htm*.tmp
pm_to_blib
Zonemaster-CLI-*
Zonemaster-CLI-*.tar.gz
MANIFEST.bak
*.bak
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
language: perl
perl:
- "5.24"
- "5.22"
- "5.20"
- "5.18"
Expand Down
16 changes: 15 additions & 1 deletion Changes
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
Release history for Perl module Zonemaster::CLI
Release history for Zonemaster component Zonemaster-CLI

v1.1.1 2017-11-02 Public release

Fixed:
- Update licensing (#58)
- Specify smallest version of Locale::TextDomain i Makefile.PL. (#57)
- Updated installation instruction (#53)
- Changed dependency from Net::LDNS to Zonemaster::LDNS due to
name space change (#51)
- Various updates to packaging (#52)
- Fix Commonmark rendering on Github. Replace NBSP with SPACE. (#49)
- Changed dependency from Zonemaster to Zonemaster::Engine due
to name space change (#43)


v1.1.0 2017-04-04 Public pre-release
- This release will not be published on CPAN since it contains updates that have
Expand Down
18 changes: 15 additions & 3 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
Copyright (c) 2013, IIS (The Internet Infrastructure Foundation)
Copyright (c) 2013, AFNIC
### Code license

Copyright (c) 2013-2017, IIS (The Internet Foundation in Sweden)
Copyright (c) 2013-2017, AFNIC
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
Expand All @@ -21,4 +23,14 @@ ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


### Documentation license

Copyright (c) 2013-2017, IIS (The Internet Foundation in Sweden)
Copyright (c) 2013-2017, AFNIC
Creative Commons Attribution 4.0 International License

You should have received a copy of the license along with this
work. If not, see <https://creativecommons.org/licenses/by/4.0/>.
7 changes: 2 additions & 5 deletions MANIFEST
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.perltidyrc
Changes
docs/installation.md
docs/Installation.md
inc/Module/Install.pm
inc/Module/Install/Base.pm
inc/Module/Install/Can.pm
Expand All @@ -19,11 +18,9 @@ META.yml
README.md
script/zonemaster-cli
script/zonemaster-info
share/en.po
share/fr.po
share/Makefile
share/locale/en/LC_MESSAGES/Zonemaster-CLI.mo
share/locale/fr/LC_MESSAGES/Zonemaster-CLI.mo
share/locale/sv/LC_MESSAGES/Zonemaster-CLI.mo
share/sv.po
t/00-load.t
USING.md
77 changes: 66 additions & 11 deletions MANIFEST.SKIP
Original file line number Diff line number Diff line change
@@ -1,12 +1,67 @@
.git
.gitignore
.perltidyrc
.perlcriticrc
.travis.yml
MYMETA.json
MYMETA.yml
^Makefile$
^blib
.tar.gz$
.bak$
^\.perltidyrc$
^\.perlcriticrc$
^\.travis\.yml$
^MANIFEST\.SKIP$

\.tar\.gz$
\.bak$
\.po$

#!start included /usr/share/perl/5.20/ExtUtils/MANIFEST.SKIP
# Avoid version control files.
\bRCS\b
\bCVS\b
\bSCCS\b
,v$
\B\.svn\b
\B\.git\b
\B\.gitignore\b
\b_darcs\b
\B\.cvsignore$

# Avoid VMS specific MakeMaker generated files
\bDescrip.MMS$
\bDESCRIP.MMS$
\bdescrip.mms$

# Avoid Makemaker generated and utility files.
\bMANIFEST\.bak
\bMakefile$
\bblib/
\bMakeMaker-\d
\bpm_to_blib\.ts$
\bpm_to_blib$
\bblibdirs\.ts$ # 6.18 through 6.25 generated this

# Avoid Module::Build generated and utility files.
\bBuild$
\b_build/
\bBuild.bat$
\bBuild.COM$
\bBUILD.COM$
\bbuild.com$

# Avoid temp and backup files.
~$
\.old$
\#$
\b\.#
\.bak$
\.tmp$
\.#
\.rej$

# Avoid OS-specific files/dirs
# Mac OSX metadata
\B\.DS_Store
# Mac OSX SMB mount metadata files
\B\._

# Avoid Devel::Cover and Devel::CoverX::Covered files.
\bcover_db\b
\bcovered\b

# Avoid MYMETA files
^MYMETA\.
#!end included /usr/share/perl/5.20/ExtUtils/MANIFEST.SKIP

27 changes: 14 additions & 13 deletions Makefile.PL
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,36 @@ use inc::Module::Install;
use ExtUtils::MakeMaker ();

name 'Zonemaster-CLI';
author q{Calle Dybedahl <calle@init.se>};
license 'bsd';
all_from 'lib/Zonemaster/CLI.pm';

perl_version 5.014002;

tests_recursive( 't' );

resources(
license => 'http://www.opensource.org/licenses/BSD-3-Clause',
repository => 'https://github.com/dotse/zonemaster-cli',
bugtracker => 'https://github.com/dotse/zonemaster-cli/issues',
);

configure_requires( 'Module::Install' => 0, );
configure_requires( 'Locale::Msgfmt' => 0.15, );

build_requires( 'Test::More' => 0, );

requires(
'Zonemaster::Engine' => 0,
'version' => 0.77,
'MooseX::Getopt' => 0,
'Getopt::Long::Descriptive' => 0,
'Net::LDNS' => 0.65,
'Locale::TextDomain' => 0,
'Text::Reflow' => 0,
'JSON::XS' => 0,
'JSON::XS' => 0,
'Locale::TextDomain' => 1.23,
'MooseX::Getopt' => 0,
'Text::Reflow' => 0,
'Zonemaster::Engine' => 2.0,
'Zonemaster::LDNS' => 1.0,
);

sub MY::postamble {
return <<'MAKE_FRAG';
$(MYEXTLIB): share/Makefile
cd share && $(MAKE) all
MAKE_FRAG
};

install_script 'zonemaster-cli';
install_share;

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,20 @@ For an overview of the Zonemaster software, please see the
Before you install the Zonemaster CLI utility, you need the
Zonemaster Engine test framework installed. Please see the
[Zonemaster Engine installation
instructions](https://github.com/dotse/zonemaster-engine/blob/master/docs/installation.md).
instructions](https://github.com/dotse/zonemaster-engine/blob/master/docs/Installation.md).

Installation
============

Installation instructions for the CLI
[installation](docs/installation.md) document.
[installation](docs/Installation.md) document.


### Configuration

This repository does not need any specific configuration.

### Documentation
### Documentation

Other than the installation documentation, no specific documentation is needed.
The [using](https://github.com/dotse/zonemaster-cli/blob/master/USING.md)
Expand All @@ -45,7 +45,7 @@ You can follow the project in these two mailinglists:
* [zonemaster-users](http://lists.iis.se/cgi-bin/mailman/listinfo/zonemaster-users)
* [zonemaster-devel](http://lists.iis.se/cgi-bin/mailman/listinfo/zonemaster-devel)

### Contact or Bug reporting
### Contact or Bug reporting

For any contacts or bug reporting, please send a mail to
"contact@zonemaster.net".
Expand Down
120 changes: 120 additions & 0 deletions docs/Installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
# Installation

## Overview

This document describes prerequisites, installation and post-install sanity
checking for Zonemaster::CLI. The final section wraps up with a few pointer to
other interfaces to Zonemaster. For an overview of the Zonemaster product,
please see the [main Zonemaster Repository].


## Prerequisites

Before installing Zonemaster::CLI, you should [install Zonemaster::Engine][
Zonemaster::Engine installation].

> **Note:** [Zonemaster::Engine] and [Zonemaster::LDNS] are dependencies of
> Zonemaster::CLI. Zonemaster::LDNS has a special installation requirement,
> and Zonemaster::Engine has a list of dependencies that you may prefer to
> install from your operating system distribution (rather than CPAN).
> We recommend following the Zonemaster::Engine installation instruction.
For details on supported versions of Perl and operating system for
Zonemaster::CLI, see the [declaration of prerequisites].


## Installation

This instruction covers the following operating systems:

* [CentOS](#1-centos)
* [Debian](#2-debian)
* [FreeBSD](#3-freebsd)
* [Ubuntu](#4-ubuntu)


### 1. CentOS

Install Zonemaster::CLI and dependencies:

```sh
sudo cpan -i Zonemaster::CLI
```


### 2. Debian

Install dependencies:

```sh
sudo apt-get install libmoosex-getopt-perl libtext-reflow-perl libmodule-install-perl
```

Install Zonemaster::CLI:

```sh
sudo cpan -i Zonemaster::CLI
```


### 3. FreeBSD

Become root:

```sh
su -l
```

Install dependencies available from binary packages:

```sh
pkg install p5-JSON-XS p5-Locale-libintl p5-MooseX-Getopt p5-Text-Reflow
```

Install Zonemaster::CLI:

```sh
cpan -i Zonemaster::CLI
```


### 4. Ubuntu

Use the procedure for installation on [Debian](#2-debian).


## Post-installation sanity check

Run the zonemaster-cli command:

```sh
zonemaster-cli --test basic zonemaster.net
```

The command is expected to take a few seconds and print some results about the delegation of zonemaster.net.


## What to do next?

* For a web GUI, follow the [Zonemaster::Backend][Zonemaster::Backend
installation] and [Zonemaster::GUI installation] instructions.
* For a [JSON-RPC][JSON-RPC API] frontend, follow the [Zonemaster::Backend
installation] instruction.

-------

[Declaration of prerequisites]: https://github.com/dotse/zonemaster/blob/master/README.md#prerequisites
[JSON-RPC API]: https://github.com/dotse/zonemaster-backend/blob/master/docs/API.md
[Main Zonemaster repository]: https://github.com/dotse/zonemaster/blob/master/README.md
[Zonemaster::Backend installation]: https://github.com/dotse/zonemaster-backend/blob/master/docs/Installation.md
[Zonemaster::Engine installation]: https://github.com/dotse/zonemaster-engine/blob/master/docs/Installation.md
[Zonemaster::Engine]: https://github.com/dotse/zonemaster-engine/blob/master/README.md
[Zonemaster::GUI installation]: https://github.com/dotse/zonemaster-gui/blob/master/docs/Installation.md
[Zonemaster::LDNS]: https://github.com/dotse/zonemaster-ldns/blob/master/README.md

Copyright (c) 2013 - 2017, IIS (The Internet Foundation in Sweden) \
Copyright (c) 2013 - 2017, AFNIC \
Creative Commons Attribution 4.0 International License

You should have received a copy of the license along with this
work. If not, see <http://creativecommons.org/licenses/by/4.0/>.
Loading

0 comments on commit 6573f12

Please sign in to comment.