Uploaded image for project: 'Solr'
  1. Solr
  2. SOLR-13537

Build Status Badge in git README

    XMLWordPrintableJSON

    Details

    • Type: Wish
    • Status: Resolved
    • Priority: Trivial
    • Resolution: Done
    • Affects Version/s: 8.2, master (9.0)
    • Fix Version/s: None
    • Component/s: Build, documentation
    • Labels:
      None

      Description

      In order to aid developers and DevOps engineers who are working in a git-driven ecosystem, it would be helpful to see the status builds in the README. This is a standard for many open source projects. I think one could debate whether we should have a multi-line build badge visual in the README because people need to know about the builds for various versions and platforms in the case of Lucene/Solr because it is such a large and widely used project, in a variety of environments. The badges not only celebrate that fact, they support its persistence in the future with new developers who look for such information instictively.

      I would recommend the active build pipelines (currently 8.x and 9.x) for each platform, Linux, Windows, MacOSX, and Solaris.

        Attachments

        1. Single Line Badges.png
          77 kB
          Marcus Eagan
        2. Simple Artifact Build Badges.png
          88 kB
          Marcus Eagan
        3. Simple Artifact Build Badge.png
          81 kB
          Marcus Eagan
        4. Markdown Preview Of Build Status README.png
          122 kB
          Marcus Eagan

          Issue Links

            Activity

              People

              • Assignee:
                gerlowskija Jason Gerlowski
                Reporter:
                marcussorealheis Marcus Eagan
              • Votes:
                1 Vote for this issue
                Watchers:
                7 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 40m
                  40m