Coder Social home page Coder Social logo

Comments (6)

mcanlas avatar mcanlas commented on July 17, 2024

Are there projects that already have a mechanism for this?

from sbt-extras.

dwijnand avatar dwijnand commented on July 17, 2024

Not really. https://github.com/tpolecat/tut is the closest thing.

We can go the high-tech route of parsing the markdown and extracting code blocks of a given shape, say those that start with "```bash", and then validate those.

Or we can go the low-tech route and use markers (invisible in the rendered form) to chop out the code block and validate it.

Here I'd go with the latter, YAGNI route.

from sbt-extras.

dwijnand avatar dwijnand commented on July 17, 2024

Perhaps CI could push "Update README shell session snippets" commits rather than fail the build..

from sbt-extras.

dwijnand avatar dwijnand commented on July 17, 2024

I think there's some prior art one could look in @alexarchambault's handy work in https://github.com/coursier/coursier.

from sbt-extras.

alexarchambault avatar alexarchambault commented on July 17, 2024

@dwijnand I removed the need to update the README some time ago… It was handled all by sbt-release, and all was running on my machine (not the CI).

from sbt-extras.

dwijnand avatar dwijnand commented on July 17, 2024

This would require having a java executable in CI, either a real one or a mocked up one, and I think I'd rather leave this using the minimal TravisCI image & not doing the mocking.

So I guess we can keep using adult supervision.

from sbt-extras.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.