flyx / NimYAML

YAML implementation for Nim
https://nimyaml.org
Other
186 stars 36 forks source link

Test supported versions #137

Closed arnetheduck closed 1 year ago

arnetheduck commented 1 year ago

Per readme, NimYAML supports Nim 1.4.0+ - this CI change keeps the readme honest.

flyx commented 1 year ago

This PR also shows that 1.4.0 isn't actually supported anymore :/

I won't bring back compatibility to 1.4.0 so I can't merge this PR, but feel free to modify it to update the Readme so it says 1.6.0+.

My plan is to release NimYAML 2.0.0 soon with some smaller breaking changes and support for Nim 2+ which would make this PR obsolete but I'd merge an updated PR to fix the Readme in the meantime.

arnetheduck commented 1 year ago

Looks like 1.6 is also failing - we use the library successfully with 1.6 (we would probably simply stick with this version if 1.6 support is dropped since 2.0 has quite a few problems still), so maybe it's a test-only problem.

flyx commented 1 year ago

The current HEAD has changes that use Nim 2.0 features, and thus doesn't work with Nim 1.6 anymore. I have yet to finish the release so that everything is properly documented.

If you stick to Nim 1.6, stay at the previous NimYAML release. There are only minor bugfixes in the new release and if you didn't encounter those bugs yet they probably don't affect you. In the case that you do have problems, please raise an issue since I will only continue maintaining the NimYAML 1.x line if I know that there are actually projects that benefit from it.

arnetheduck commented 1 year ago

The current HEAD has changes that use Nim 2.0 features, and thus doesn't work with Nim 1.6 anymore.

Alright, I'll close this PR for now (we use the 1.1 release indeed) - that said, I think it's useful to do something like this to HEAD as well so that version support regressions are caught during development - ie test explicit releases rather than tags such as stable which change over time - we don't upgrade yaml a lot (the hallmark of a great library!), but when we do this would be helpful.

flyx commented 1 year ago

I incorporated this in the newest release by adding Nim 2.0.x to the test matrix.