Home

Awesome

Log4brains <!-- omit in toc -->

<p align="center"> <a href="#readme"> <img src="https://github.com/thomvaill/log4brains/raw/master/docs/Log4brains-logo-full.png" alt="Log4brains logo" width="276" /> </a> </p> <p align="center"> <a href="https://github.com/thomvaill/log4brains/blob/master/LICENSE"> <img src="https://img.shields.io/badge/license-Apache%202-blue" alt="License" /> </a> <a href="https://github.com/thomvaill/log4brains/actions?query=workflow%3ABuild"> <img src="https://github.com/thomvaill/log4brains/workflows/Build/badge.svg" alt="Build Status" /> </a> <a href="https://github.com/thomvaill/log4brains/releases"> <img src="https://img.shields.io/npm/v/log4brains?label=log4brains" alt="log4brains latest version" /> </a> <a href="https://thomvaill.github.io/log4brains/adr/"> <img src="https://thomvaill.github.io/log4brains/adr/badge.svg" alt="Log4brains ADRs" /> </a> </p>

Log4brains is a docs-as-code knowledge base for your development and infrastructure projects. It enables you to log Architecture Decision Records (ADR) right from your IDE and to publish them automatically as a static website.

By logging your decisions chronologically, you will be able to:

<details> <summary>Features</summary> <p>

Coming soon:

</p> </details> <br /> <p align="center"> <a href="https://www.youtube.com/watch?v=HDEwOCn9T0w" title="Click to watch the full screencast"> <img src="https://github.com/thomvaill/log4brains/raw/master/docs/demo.gif" alt="Log4brains demo" width="838" /> </a> </p> <p align="center"><a href="https://www.youtube.com/watch?v=HDEwOCn9T0w">ğŸŽžï¸ Watch the full screencast</a> - <a href="https://thomvaill.github.io/log4brains/adr/">⚡ See an example (Log4brains' own ADRs)</a></p>

Table of contents <!-- omit in toc -->

🚀 Getting started

We recommend storing your Architecture Decision Records (ADR) next to the source code of your project, in the same git repository, to keep them in sync.

To get started, run these commands inside your project root folder:

npm install -g log4brains
log4brains init

It will ask you several questions to get Log4brains properly configured. It will also create the required template files and your first ADR as well. Then, you can start the web UI to preview your knowledge base locally:

log4brains preview

In this mode, the Hot Reload feature is enabled: any change you make to a markdown file from your IDE is applied live.

To create a new ADR from your template, run this command:

log4brains adr new

Get all the available commands and options by running log4brains --help.

Finally, do not forget to set up your CI/CD pipeline to automatically publish your knowledge base on a static website service like GitHub/GitLab Pages or S3.

🤔 What is an ADR and why should you use them

The term ADR became popular in 2011 with Michael Nygard's article: documenting architecture decisions. He aimed to reconcile Agile methods with software documentation by creating a very concise template to record functional or non-functional "architecturally significant" decisions in a lightweight format like markdown. The original template had only a few parts:

There are other ADR templates like Y-Statements or MADR, which is the default one that is shipped with Log4brains.

As you can guess from the template above, an ADR is immutable. Only its status can change. Thanks to this, your documentation is never out-of-date! Yes, an ADR can be deprecated or superseded by another one, but it was at least true one day! And even if it's not the case anymore, it is still a precious piece of information.

This leads us to the main goals of this methodology:

To learn more on this topic, I recommend you to read these great resources:

📨 CI/CD configuration examples

Log4brains lets you publish automatically your knowledge base on the static hosting service of your choice, thanks to the log4brains-web build command. Here are some configuration examples for the most common hosting services / CI runners.

<details> <summary>Publish to GitHub Pages with GitHub Actions</summary> <p>

First, create .github/workflows/publish-log4brains.yml and adapt it to your case:

name: Publish Log4brains
on:
  push:
    branches:
      - master
jobs:
  build-and-publish:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2.3.4
        with:
          persist-credentials: false # required by JamesIves/github-pages-deploy-action
          fetch-depth: 0 # required by Log4brains to work correctly (needs the whole Git history)
      - name: Install Node
        uses: actions/setup-node@v1
        with:
          node-version: "14"
      - name: Install and Build Log4brains
        run: |
          npm install -g log4brains
          log4brains build --basePath /${GITHUB_REPOSITORY#*/}/log4brains
      - name: Deploy
        uses: JamesIves/github-pages-deploy-action@3.7.1
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          BRANCH: gh-pages
          FOLDER: .log4brains/out
          TARGET_FOLDER: log4brains

After the first run, this workflow will create a gh-pages branch in your repository containing the generated static files to serve. Then, we have to tell GitHub that we don't want to use Jekyll, otherwise, you will get a 404 error:

git checkout gh-pages
touch .nojekyll
git add .nojekyll
git commit -m "Add .nojekyll for Log4brains"
git push

Finally, you can enable your GitHub page:

You should now be able to see your knowledge base at https://<username>.github.io/<repository>/log4brains/. It will be re-built and published every time you push on master.

</p> </details> <details> <summary>Publish to GitLab Pages with GitLab CI</summary> <p>

Create your .gitlab-ci.yml and adapt it to your case:

image: node:14-alpine3.12
pages:
  stage: deploy
  variables:
    GIT_DEPTH: 0 # required by Log4brains to work correctly (needs the whole Git history)
  script:
    - mkdir -p public
    - npm install -g --unsafe-perm log4brains
    - log4brains build --basePath /$CI_PROJECT_NAME/log4brains --out public/log4brains
  artifacts:
    paths:
      - public
  rules:
    - if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH"

You should now be able to see your knowledge base at https://<username>.gitlab.io/<repository>/log4brains/. It will be re-built and published every time you push on master.

</p> </details> <details> <summary>Publish to S3</summary> <p>

First, create a bucket with the "Static website hosting" feature enabled:

# This is an example: replace with the bucket name of your choice
export BUCKET_NAME=yourcompany-yourproject-log4brains

aws s3api create-bucket --acl public-read --bucket ${BUCKET_NAME}
read -r -d '' BUCKET_POLICY << EOP
{
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": "*",
      "Action": "s3:GetObject",
      "Resource": "arn:aws:s3:::${BUCKET_NAME}/*"
    }
  ]
}
EOP
aws s3api put-bucket-policy --bucket ${BUCKET_NAME} --policy "$BUCKET_POLICY"
aws s3 website s3://${BUCKET_NAME} --index-document index.html

Then, configure your CI to run these commands:

Your knowledge base will be available on http://<YOUR BUCKET>.s3-website-<YOUR REGION>.amazonaws.com/. You can get some inspiration on implementing this workflow for GitHub Actions or GitLab CI by looking at the previous examples.

</p> </details>

Finally, you can add the ADR badge to your README.md!

<table> <tbody> <tr> <td><a href="https://thomvaill.github.io/log4brains/adr/"><img src="https://thomvaill.github.io/log4brains/adr/badge.svg" alt="Log4brains ADRs" /></a></td> <td><code>[![Log4brains ADRs](http://URL-of-your-knowledge-base/badge.svg)](http://URL-of-your-knowledge-base/)</code></td> </tr> </tbody> </table>

❓ FAQ

What are the prerequisites?

Is Log4brains only for JS projects?

Of course not! Log4brains is developed with TypeScript and use NPM as a package manager. You need Node and NPM to be installed globally to run Log4brains, but it is designed to work for all kind of projects.

What about multi-package projects?

Log4brains supports both mono and multi packages projects. The log4brains init command will prompt you regarding this.

In the case of a multi-package project, you have two options:

Here is an example of a typical file structure for each case:

<details> <summary>Simple mono-package project</summary> <p>
project-root
├── docs
|   └── adr
|       ├── 20200101-your-first-adr.md
|       ├── 20200115-your-second-adr.md
|       ├── [...]
|       ├── index.md
|       └── template.md
[...]
</p> </details> <details> <summary>Multi-package project in a mono-repository</summary> <p>
project-root
├── docs
|   └── adr
|       ├── 20200101-your-first-global-adr.md
|       ├── 20200115-your-second-global-adr.md
|       ├── [...]
|       ├── index.md
|       └── template.md
├── packages
|   ├── package1
|   |   ├── docs
|   |   |   └── adr
|   |   |       ├── 20200102-your-first-package-specific-adr.md
|   |   |       ├── 20200116-your-second-package-specific-adr.md
|   |   |       [...]
|   |   [...]
|   ├── package2
|   |   ├── docs
|   |   |   └── adr
|   |   |       ├── [...]
|   |   |       [...]
|   |   [...]
|   [...]
[...]
</p> </details> <details> <summary>Multi-package with one repository per package</summary> <p>

For the moment in one central repository (specific for the docs, or not):

project-docs
├── adr
|   ├── global
|   |   ├── 20200101-your-first-global-adr.md
|   |   ├── 20200115-your-second-global-adr.md
|   |   ├── [...]
|   |   ├── index.md
|   |   └── template.md
|   ├── package1
|   |   ├── 20200102-your-first-package-specific-adr.md
|   |   ├── 20200116-your-second-package-specific-adr.md
|   |   [...]
|   ├── package2
|   |   ├── [...]
|   |   [...]
|   [...]
[...]

In the future:

project-docs
├── adr
|   ├── 20200101-your-first-global-adr.md
|   ├── 20200115-your-second-global-adr.md
|   ├── [...]
|   ├── index.md
|   └── template.md
[...]

repo1
├── docs
|   └── adr
|       ├── 20200102-your-first-package-specific-adr.md
|       ├── 20200116-your-second-package-specific-adr.md
|       [...]
[...]

repo2
├── docs
|   └── adr
|       ├── [...]
|       [...]
[...]
</p> </details>

How to configure .log4brains.yml?

This file is automatically created when you run log4brains init (cf getting started), but you may need to configure it manually.

Here is an example with just the required fields:

project:
  name: Foo Bar # The name that should be displayed in the UI
  tz: Europe/Paris # The timezone that you use for the dates in your ADR files
  adrFolder: ./docs/adr # The location of your ADR files

If you have multiple packages in your project, you may want to support package-specific ADRs by setting the optional project.packages field:

project:
  # [...]
  packages:
    - name: backend # The name (unique identifier) of the package
      path: ./packages/backend # The location of its codebase
      adrFolder: ./packages/backend/docs/adr # The location of its ADR files
#   - ...

Another optional field is project.repository, which is normally automatically guessed by Log4brains to create links to GitHub, GitLab, etc. But in some cases, like for GitHub or GitLab enterprise, you have to configure it manually:

project:
  #  [...]
  repository:
    url: https://github.com/foo/bar # Absolute URL of your repository
    provider: github # Supported providers: github, gitlab, bitbucket. Use `generic` if yours is not supported
    viewFileUriPattern: /blob/%branch/%path # Only required for `generic` providers

Is Log4brains also available as a Docker image?

Yes! https://hub.docker.com/r/thomvaill/log4brains

📣 Your feedback is welcome!

I had the idea of Log4brains based on my needs and my past experiences with ADRs, but it is now constantly evolving with your precious feedback. You are very welcome to create a new feedback in the Discussions or to reach out to me at thomvaill@bluebricks.dev. Thanks a lot 🙏

Contributing

Pull Requests are more than welcome! Please read CONTRIBUTING.md for more details. You can also create a new issue or give your feedback.

Acknowledgments

License

This project is licensed under the Apache 2.0 license, Copyright (c) 2020 Thomas Vaillant. See the LICENSE file for more information.