Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

What are the status tags, like [build | passing]

May be a well known question, but actually I'm asking this, because I'm not familiar with these tags.

status tags

I've seen similar types of tags in various Github projects, especially in their README.md. My questions are manifold regarding these:

  1. What's the purpose of these tags?
  2. How to generate them?
  3. Is there any good practice or documentation that suggests what types of tags can be used or should be used in a project?
  4. When a project can be determined viable using such a tag?
like image 258
Mayeenul Islam Avatar asked Feb 22 '16 20:02

Mayeenul Islam


People also ask

What is a build status?

Build Status helps the team review product builds statistics, such as the number of attempted builds, the number that were successful, and the number that failed. Build status is an indicator of project health.

What does build passing mean?

- "build passing" indicates that the project's tests all pass as expected. If you see that the build for a project is "broken" it means the software does not work as advertised! This is a clear sign that you should not be using it (until it gets fixed!) ...

How do you add a build status in readme?

Add a build badge to your readme.mdClick on the badge, then select the branch you want to report on. Paste the code into your readme.md . There are no more steps. You've successfully added a build badge.

What is build in GitHub?

To build using GitHub triggers, you'll need to push and commit changes to your connected source repository or configure your build on pull requests. Once you have checked in your changes, Cloud Build will build your code. To view your build changes on GitHub, go to the Checks tab in your repository.


1 Answers

What's the purpose of these tags?

These images are provided by external services, often continuous integration services, and are used to show interesting information about the repository.

For example, the first badge you show in your example says that the build is "passing" (the exact definition of this will be build-specific, but it commonly means that the tests pass and nothing blew up during the most recent build).

The third example, coverage: 12%, is a code coverage report.

How to generate them?

Each service will have its own way.

The second badge in your example is from Scrutinizer, and unfortunately I can't find documentation about its badges. But most badging systems work by giving you a link for each project or job that you can use on your website or GitHub or whatever, and when a build happens the badge's appearance is updated accordingly.

The Travis CI documentation contains a good example.

Having answered the first to questions, I think your last two largely disappear. The badges that can be used are determined by whatever services you can find. The badges that should be used are entirely up to you.

like image 119
Chris Avatar answered Oct 02 '22 06:10

Chris