search

metanorma / mnconvert-ruby

Ruby gem wrapper for mnconvert
2 stars 0 forks source link

Feature/make input format optional #2

Closed CAMOBAP closed 2 years ago

CAMOBAP commented 2 years ago

Metanorma PR checklist

Related PRs

ronaldtse commented 2 years ago

We should add tests and a validation step for RFC XML (as an input format) as well, in a new issue.

CAMOBAP commented 2 years ago

@ronaldtse this PR should be released as major change (because breaking change)

But we have automatic release after downstream update here https://github.com/metanorma/mnconvert-ruby/blob/main/.github/workflows/release-tag.yml

To be honest, IDK how to handle this except removing release-tag workflow

Ideally, we should have here some tool for git log analyzing and next version suggestion like https://github.com/semantic-release/semantic-release. Unfortunatelly this tool is node-based, I would not like to drag node stuff into ruby repo. Also I wasn't able to find similar ruby tool yet

ronaldtse commented 2 years ago

@CAMOBAP I wouldn't consider this change a breaking change -- it does not break any existing functionality. Is there anything I'm missing?

ronaldtse commented 2 years ago

Oh you mean this change:

  def self.convert(input_file, output_file, input_format, opts = {})
     validate(opts, input_format)

to

   def self.convert(input_file, output_file, opts = {})
     validate(opts)

Yes it is breaking.

ronaldtse commented 2 years ago

Thanks @camobap!

CAMOBAP commented 2 years ago

@ronaldtse @Intelligent2013 still open question about next release version of this gem, I think make sense to switch to manual release workflow here, how do you think?

ronaldtse commented 2 years ago

Agree.

CAMOBAP commented 2 years ago

@ronaldtse I have an idea, we can automatically report a ticket to this repo, once new mnconvert.jar is released, how do you think?