Skip to content

Commit

Permalink
Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ptr727 committed Mar 14, 2024
1 parent 84d70ae commit 2008472
Show file tree
Hide file tree
Showing 10 changed files with 12 additions and 22 deletions.
12 changes: 5 additions & 7 deletions Make/Build.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
#!/bin/bash

set -e

## Dependencies:
# sudo apt install m4 docker-compose-plugin docker-buildx-plugin
# Docker v25+, .NET SDK v8+
# sudo apt update && sudo apt install m4 dotnet-sdk-8.0 docker-compose-plugin docker-buildx-plugin


## Test installing in container:
# docker run -it --rm ubuntu:jammy /bin/bash
Expand Down Expand Up @@ -34,12 +38,6 @@
# Clean.sh : Shutdown compose stack and delete images.


# Echo commands
set -x

# Exit on error
set -e

# Build Dockerfile
function BuildDockerfile {
# Build x64 and ARM64 targets
Expand Down
1 change: 0 additions & 1 deletion Make/Clean.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
#!/bin/bash

set -x
set -e

# Delete images
Expand Down
4 changes: 0 additions & 4 deletions Make/Create.sh
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
#!/bin/bash

# Echo commands
set -x

# Exit on error
set -e

# Create Dockerfile from M4 file
Expand Down
1 change: 0 additions & 1 deletion Make/Down-develop.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
#!/bin/bash

set -x
set -e

# Stop stack and cleanup volumes
Expand Down
1 change: 0 additions & 1 deletion Make/Down.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
#!/bin/bash

set -x
set -e

# Stop stack and cleanup volumes
Expand Down
1 change: 0 additions & 1 deletion Make/Test.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
#!/bin/bash

set -x
set -e

# Create Dockerfile from M4
Expand Down
1 change: 0 additions & 1 deletion Make/Up-develop.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
#!/bin/bash

set -x
set -e

# Launch stack
Expand Down
1 change: 0 additions & 1 deletion Make/Up.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
#!/bin/bash

set -x
set -e

# Launch stack
Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Licensed under the [MIT License][license].

## Release Notes

- Version 2.2:
- Simplified `Dockerfile` creation by using shell scripts instead of a `Makefile` (that I found too difficult to maintain and debug).
- Version 2.1:
- Added ARM64 images per user [request](https://github.com/ptr727/NxWitness/issues/131).
- Note that testing was limited to verifying that the containers run on a Raspberry Pi 5.
Expand All @@ -40,7 +42,7 @@ Images are published on [Docker Hub][hub]:

Images are tagged as follows:

- `latest`: Latest published version, `docker pull docker.io/ptr727/nxmeta:latest`.
- `latest`: Latest published version, e.g. `docker pull docker.io/ptr727/nxmeta:latest`.
- `stable`: Latest released version, e.g. `docker pull docker.io/ptr727/nxmeta:stable`.
- `rc`: Latest RC version, e.g. `docker pull docker.io/ptr727/nxmeta:rc`.
- `beta`: Latest Beta version, e.g. `docker pull docker.io/ptr727/nxmeta:beta`
Expand All @@ -50,7 +52,7 @@ Images are tagged as follows:
Notes:

- `latest` and `stable` may be the same version if all builds are released builds.
- `rc` and `beta` tags are only built when RC and Beta builds are published, and may be older than current `latest` or `stable` builds.
- `rc` and `beta` tags are only built when RC and Beta builds are published by Nx, and may be older than current `latest` or `stable` builds.
- See [Build Process](#build-process) for determination of the "released" status of a build.

The images are updated weekly, picking up the latest upstream Ubuntu updates and newly released Nx product versions.
Expand Down Expand Up @@ -237,7 +239,7 @@ services:

## Product Information

### Releases Information
### Release Information

- Nx Witness:
- [Downloads API](https://nxvms.com/api/utils/downloads)
Expand Down Expand Up @@ -278,7 +280,7 @@ Build overview:
- The "released" status of a build follows the same method as Nx uses in [`isBuildPublished()`][isbuildpublished] where `release_date` and `release_delivery_days` from the [Releases JSON API][nxwitness_releases] must be greater than `0`
- [`Matrix.json`](./Make/Matrix.json) is created from the `Version.json` file and is used during pipeline builds using a [Matrix](https://docs.github.com/en/actions/using-jobs/using-a-matrix-for-your-jobs) strategy.
- Automated builds are done using [GitHub Actions](https://docs.github.com/en/actions) and the [`BuildPublishPipeline.yml`](./.github/workflows/BuildPublishPipeline.yml) pipeline.
- Version history is maintained and used by `CreateMatrix` such that generic tags, e.g. `latest`, will never result in a lesser version number, i.e. break-fix-forward only, see [Issue #62](https://github.com/ptr727/NxWitness/issues/62) for details on Nx re-publishing `release` builds using an older version breaking already upgraded systems.
- Version history is maintained and used by `CreateMatrix` such that generic tags, e.g. `latest`, will never result in a lesser version number, i.e. break-fix-forward only, see [Issue #62](https://github.com/ptr727/NxWitness/issues/62) for details on Nx re-publishing "released" builds using an older version breaking already upgraded systems.

Local testing:

Expand Down
2 changes: 1 addition & 1 deletion version.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
"version": "2.1",
"version": "2.2",
"publicReleaseRefSpec": [
"^refs/heads/main$"
],
Expand Down

0 comments on commit 2008472

Please sign in to comment.