What are the status tags, for example [build | walkthrough]

It may be a well-known question, but actually I ask about it because I am not familiar with these tags.

status tags

I have seen similar tag types in various Github projects, especially in their README.md . My questions in this regard are many:

  • What is the purpose of these tags?
  • How to generate them?
  • Is there any good practice or documentation that tells what types of tags can be used or used in a project?
  • When can a project be identified as viable using such a tag?
+7
github build tags status
source share
1 answer

What is the purpose of these tags?

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

For example, the first icon that you show in your example says that the assembly is β€œpassing” (an exact definition of this will be specific to the assembly, but usually this means that the tests pass and nothing exploded during the last build).

Third example: coverage: 12% is a report.

How to generate them?

Each service will have its own path.

The second icon in your example is Scrutinizer , and unfortunately, I cannot find documentation about its icons. But most of the badging systems work by providing you with a link for each project or task that you can use on your website or on GitHub or something else, and when the build happens, the look of the icon is updated accordingly.

The Travis CI documentation provides a good example.

When I answer questions first, I think your last two basically disappear. The icons that can be used are determined by any services you can find. The icons to be used are completely up to you.

+14
source share

All Articles