Project

sip_validator

0.01
No commit activity in last 3 years
No release in over 3 years
sip_validatorbakaoh/sip_validatorHomepageDocumentationSource CodeBug TrackerWiki
Small library to check if SIP doc has valid front matter
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
4,556
Stars
0
Forks
5
Watchers
2
 Releases
Current version
0.1.1
Total releases
2
First release
2019-08-16
Latest release
2019-08-19
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2019-08-17
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.16
rake
~> 10.0
rspec
~> 3.0

Runtime

activemodel
>= 0
front_matter_parser
~> 0.1.1
 Project Readme

SIP validator

Gem

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)

sip_validator INPUT_FILES

Usage (as a lib)

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