https://github.com/bakaoh/sip_validator

https://github.com/bakaoh/sip_validator

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/bakaoh/sip_validator
• Owner: bakaoh
• License: mit
• Created: 2019-08-16T03:39:31.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-08-19T08:15:15.000Z (over 5 years ago)
• Last Synced: 2024-11-05T12:21:57.755Z (2 months ago)
• Language: Ruby
• Size: 8.79 KB
• Stars: 0
• Watchers: 2
• Forks: 21
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# SIP validator

[![Gem](https://img.shields.io/gem/v/sip_validator.svg?style=flat)](http://rubygems.org/gems/sip_validator "View this project in Rubygems")

## Validation rules

### Mandatory fields

- sip or sccp

- title

- author

- status

- created

### Optional fields

- discussions-to

- layer

- replaces

- requires

- resolution

- review-period-end

- superseded-by

- updated

### Mandatory values

- `status` must be 'WIP', 'Proposed', 'Approved', 'Implemented', or 'Rejected'

## Prerequisite

- ruby

## Setup

```

gem install sip_validator

```

## Usage (command line)

```ruby

sip_validator INPUT_FILES

```

## Usage (as a lib)

```ruby

require 'sip_validator

SipValidator::Runner.run 

```

### Example

```

$sip_validator  ~/src/SIPs/SIPS/*[0-9].md

total:1, valid:1, invalid:0, errors:0

	statuses: [["Implemented", 1]]

```

## Running tests

```

bundle exec rspec

```

## Releasing new gem

```

gem bump --version patch|minor|major

bundle exec rake release

```