Bump version to 1.21.0

.github/workflows/create-release.yaml

@@ -29,7 +29,7 @@ jobs:
  On MacOS, install Litani using [Homebrew](https://brew.sh/) with
 
  ```sh
- brew install aws/tap/litani
+ brew install litani
  ```
 
  or upgrade (if it's already been installed) with:

.github/workflows/release-packages.yaml

@@ -80,7 +80,6 @@ jobs:
  - name: Create homebrew PR
  run: |
  brew update-reset
- brew tap aws/tap
- brew bump-formula-pr --tag "$RELEASE_TAG" --revision "$GITHUB_SHA" aws/tap/litani
+ brew bump-formula-pr --tag "$RELEASE_TAG" --revision "$GITHUB_SHA" litani
  env:
  HOMEBREW_GITHUB_API_TOKEN: ${{ secrets.RELEASE_CI_ACCESS_TOKEN }}

.github/workflows/run-tests

@@ -0,0 +1,18 @@
+name: Run Litani Tests
+on:
+ pull_request:
+ types: [ labeled ]
+
+jobs:
+ test-litani:
+ if: ${{ github.event.label.name == 'test' }}
+ name: Run Litani Tests
+ runs-on: macos-latest
+ steps:
+ - uses: actions/checkout@v2
+ - name: Install dependencies
+ run: |
+ brew install ninja
+ python3 -m pip install jinja2
+ - name: Run Unit and e2e tests
+ run: ./test/run

.github/workflows/update-gh-pages.yaml

@@ -0,0 +1,25 @@
+on:
+ release:
+ types: [created] 
+
+name: Update documentation
+jobs:
+ update-documentation:
+ name: Update gh-pages
+ runs-on: macos-10.15
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v2
+ - name: Install utilities
+ run: |
+ brew install scdoc mandoc coreutils ninja
+ pip3 install pyyaml jinja2
+ - name: Build doc
+ run: ./doc/configure && ninja
+ - name: Publish Documentation
+ uses: JamesIves/github-pages-deploy-action@4.1.4
+ with:
+ branch: gh-pages
+ folder: doc/out/html

.gitignore

@@ -5,6 +5,10 @@ test/output
 doc/tmp
 doc/out
 
+examples/rich-output/*.csv
+
 __pycache__/
 
 build.ninja
+
+tmp

CHANGELOG

@@ -1,5 +1,57 @@
  CHANGELOG
  `````````
+
+Version 1.21.0 -- 2022-03-04
+----------------------------
+- Add release script
+ This commit adds a script that creates a new release when run. It takes
+ the following actions:
+
+ - Update the version number in lib/litani.py;
+ - Generate a changelog and prompt the user to edit it;
+ - Merge the release branch into develop, using the changelog for the
+ merge commit;
+ - Tag the release;
+ - Create a new release candidate on the develop branch.
+
+- Litani's homebrew formula is now released on homebrew-core
+
+- Add --out-file flag to litani-dump-run
+
+ With this commit, users can now dump run files to a file instead
+ by passing --out-file flag with the file path to litani dump-run.
+
+- Add run-tests workflow
+ This commit runs Litani's test suite on PRs with label 'test'.
+
+- Render rich output in dashboard, pipeline pages
+
+ This feature allows users to render custom HTML data onto the HTML
+ dashboard, allowing Litani jobs to display their results through tables,
+ graphs, and other HTML format. This can be done both for the front page
+ or on the pipeline page.
+
+ The intention is that individual litani jobs can be used to measure
+ metrics, and then print those metrics out in an easily-viewable format.
+ Jobs that calculate metrics for the entire run can present those metrics
+ as a graph on the front page. Jobs that calculate metrics for a single
+ pipeline (or proof) can display the result on the pipeline page.
+
+ Users use this feature by adding a tag to a litani job, using the --tags
+ flag. If a job is tagged with front-page-text, Litani will render the
+ job's output onto the front page, in its own section. A tag of
+ literal-stdout will make Litani render the job's output onto the
+ pipeline page, but without any HTML escaping.
+
+- Add workflow to update gh-pages on release
+
+- Sort pipelines by status and then name.
+
+ The order with which pipelines appear in both the HTML dashboard is
+ the same as the order with which they appear in the run.json. An e2e
+ test was added to ensure that the order is indeed the intended one.
+
+
 Version 1.20.0 -- 2022-02-11
 ----------------------------
 

README.md

@@ -1,33 +1,36 @@
-AWS Build Accumulator
+Litani
 =
 
-AWS Build Accumulator collects build jobs from multiple sources before executing them
-concurrently. It provides platform-independent job control (timeouts,
-return code control) and an output format that is easy to render into
-reports (for example, using the built-in renderer). AWS Build Accumulator
-shines where your project uses multiple different build systems or requires
-a unified interface describing heterogeneous build jobs.
+Litani is a build system that provides an HTML dashboard of job results, as well
+as a JSON-formatted record of job results. It provides platform-independent job
+control (timeouts, return code control) and an output format that is easy to
+render into reports (for example, using the built-in renderer).
 
 ### Documentation
 
-Hosted [here](https://awslabs.github.io/aws-build-accumulator/).
+Hosted [here](https://awslabs.github.io/aws-build-accumulator/). The Homebrew
+and Debian packages also install the man pages locally, try
+`man litani-add-job`.
 
 
 ### Installation
 
 To install with [Homebrew](https://brew.sh):
 
 ```bash
-brew tap aws/tap
 brew install litani
 ```
 
-Documentation can also be accessed using `man`:
+On Ubuntu, Install Litani by downloading the `*.deb` package built by each release,
+available on the
+[releases](https://github.com/awslabs/aws-build-accumulator/releases) page and
+run
 
 ```bash
-man litani
+apt install -y litani-x.xx.x.deb # where x.xx.x is the release version.
 ```
 
+
 ### Dependencies
 
 If you are cloning the source code, you will need the following dependencies: