limdor / bazel-examples Goto Github PK

The goal is to have several examples including multi language projects using Bazel build system

Python 1.15% C++ 2.53% Starlark 92.16% Shell 0.64% PowerShell 3.51%

bazel-examples's Introduction

Bazel examples

AppVeyor	Bazel CI

Bazel examples that extend use cases present in the official bazel examples. Some of these examples are explained also in the presentation Introduction to Bazel to build C++ and Python.

List of examples:

bazel-examples's People

Contributors

Stargazers

Watchers

Forkers

ysf002 snyk-playground sousajo-cc azurecloudmonk fpinero danctorres choonggeun-song gowthamreddy-e

bazel-examples's Issues

Integrate buildifier for bazel examples

The examples in this repository want to show bazel best practices and recommended usages. One of the way to achieve this is doing linting in the BUILD files.
Bazel provides buildifier to achieve this goal.
In this task buildifier should be integrated in all examples and configured to run on the CI.

Buildifier integration is not working on Windows

Buildifier integration is not working on Windows in the CI and also not locally.
Could be that the Windows setup in CI is not done properly:
https://docs.bazel.build/versions/master/install-windows.html

Or could be that we are affected by one of the following bugs:
bazelbuild/buildtools#346
bazelbuild/buildtools#770

Add bazelci presubmit file in order to request the addition to the bazel ci project

Configure the CI to be able to build Python examples

Create a C++ code coverage example

Material to consider:
https://www.youtube.com/watch?v=P51Rgcbxhyk
Open bazel tickets to consider:
bazelbuild/bazel#5716

Fix Python examples integration in the CI for AppVeyor

Python examples with the default toolchain can be run locally but not in the CI. Probably there is some issue with the setup in the CI.

Create an example on how to use aspects

Create a Java code coverage example

baseline coverage is not supported in Bazel for C++. However it is not clear if it is fully working on Java or not.

This example would help to asses how is the bazel coverage in Bazel for Java and if the baseline coverage is supported or note.

Related Bazel issues:
bazelbuild/bazel#5716
bazelbuild/bazel#8324

Create a C++ hello world without libraries

In some cases CI reports success but the build fails

https://ci.appveyor.com/project/limdor/bazel-examples/builds/48850368/job/4v57eslcfbwlqw53?fullLog=true

Migrate examples to Bzlmod once buildtools module is available

Most of the examples use third party dependencies only for the buildifier rule.
In order to have it reproducible, we ping the version of rules_go, skylib, protobuf, and buildtools.
With Bzlmod it would be much simpler because then we only pin builtools and we check in the log file.

Unfortunately buildtools does not have yet a module. Once it is available, examples should be migrated.
bazelbuild/bazel-central-registry#380

The only example that should not be migrated is the one that shows how to deal with third party dependencies without Bzlmod

Execute in the CI the build commands from readme files

For each example there are several build commands that we want to show to the user. To make sure that these build commands are working all the time, they are executed in the CI adding them in the appveyor file.
The problem with this approach is that the commands are repeated, appearing once in the appveyor file and once in the Readme file.
The goal of this task is to have a script that parse the readme files to find bazel commands and these commands are executed in the CI.

Add linter for markdown files

Readme files are the base of this repository. With them the user will learn bazel.
Because of that it is important that they do not have problems like visualization issues.
To achieve that a linter for markdown files should be added and integrated with the CI.

Show how to do linting for python code in Bazel

This example should show a small Python application that contains a python test, a py_binary and an py_library and it shows how linting using pylint can be automatically done in bazel with an additional py test target.
It should take into consideration the files declared in the bazel target and not analyze everything in the folder.