search

scalingdata / liquidoc-gem

The gem source for our LiquiDoc content template parsing tool.
MIT License
9 stars 6 forks source link

Regex parsing - 0.2.0 release #2

Closed briandominick closed 6 years ago

briandominick commented 6 years ago

This PR is a release candidate for LiquiDoc 0.2.0.

It incorporates regex-based data source parsing, with one-record-per-line and named-group matching to establish variables.

To test, use the boilerplate repo at https://github.com/briandominick/liquidoc-boilerplate/pull/1.

  1. git pull the branch regex-examples.
  2. Edit the Gemfile to use this branch's gem in this repo (change gem liquidoc to gem 'liquidoc', :git => 'https://github.com/scalingdata/liquidoc-gem', :branch => 'regex-parsing').
  3. Run bundle update to update dependencies.
  4. Run bundle exec liquidoc -c _configs/liquidoc -c _configs/cfg_build-grok-patterns.yml from the liquidoc-boilerplate base directory.
  5. Output should write to _output/. Data should be populated into formatted output.
  6. Additionally, previous commands should still work against sample data in boilerplate repo. Try bundle exec liquidoc -c _configs/sample.yml to build sample files using non-regex type.

Also try against Rocana repo (scalingdata/rocana, which is private):

  1. git pull the branch ROCANA-11746 and cd to rocana-content/src/patterns.
  2. Edit the Gemfile to use this branch's gem in this repo (change gem liquidoc to gem 'liquidoc', :git => 'https://github.com/scalingdata/liquidoc-gem', :branch => 'regex-parsing').
  3. Run bundle update to update dependencies.
  4. Run bundle exec liquidoc -c cfg_build-grok-patterns.yml from the liquidoc-boilerplate base directory.
  5. Output writes to its own directory for now. Data should be populated into formatted output as reported in console.
briandominick commented 6 years ago

Thanks for the review, @matthew-dailey! I appreciate your patience with my typos and n00b Ruby. R00by? Is that a thing yet?