lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Shawn Heisey (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (SOLR-13537) Build Status Badge in git README
Date Sat, 15 Jun 2019 18:29:00 GMT

    [ https://issues.apache.org/jira/browse/SOLR-13537?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16864826#comment-16864826
] 

Shawn Heisey commented on SOLR-13537:
-------------------------------------

Does the badge reflect the build only or the build+tests?

I don't think it would be all that useful with the build only, and with the current state
of Solr tests, build+tests would be red a large percentage of the time.  That could cause
a reputation problem for the project ... although it could be argued that's a plus, as it
might be a strong motivation to make things better.  The idea proposed by [~janhoy] where
we report on a build running a smaller subset of tests (at least until Solr's full integration
tests improve) sounds good.  I think that's the only way this would be helpful right now.

We have people diligently working on improving the Solr tests so they don't fail constantly,
but it's a huge task, and isn't going to be completed quickly.  I wish I had enough free time
available to help with that.

Unless I'm mistaken, I think the badge would only show up on github.  Since github is not
the canonical source repository, and as far as I can tell the readme is not rendered by Apache
gitbox, I wonder how often our committers would actually see it.  As Jan says, the information
is not all that useful to anyone who is not working in the code, and because of the state
of Solr tests, I have doubts that it would be useful to those of us who are working in the
code.

Down the road, I do think it's a great idea, but right now, I'm not sure it is.  Consider
this a -0 vote.

Side note: This probably belongs in LUCENE, not SOLR.


> Build Status Badge in git README
> --------------------------------
>
>                 Key: SOLR-13537
>                 URL: https://issues.apache.org/jira/browse/SOLR-13537
>             Project: Solr
>          Issue Type: Wish
>      Security Level: Public(Default Security Level. Issues are Public) 
>          Components: Build, documentation
>    Affects Versions: master (9.0), 8.2
>            Reporter: Marcus Eagan
>            Priority: Trivial
>         Attachments: Markdown Preview Of Build Status README.png, Simple Artifact Build
Badge.png
>
>          Time Spent: 10m
>  Remaining Estimate: 0h
>
> 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.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org


Mime
View raw message