Skip to content

Commit

Permalink
Add a Readme
Browse files Browse the repository at this point in the history
Signed-off-by: Clement Verna <cverna@tutanota.com>
  • Loading branch information
cverna committed Oct 1, 2020
1 parent e1960b8 commit 5e24937
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
fedora-container-release
========================

This project is a Command Line Interface (CLI) tool which fetch the Fedora container base image
rootfs from [Fedora's build system](https://koji.fedoraproject.org) and prepares it to be pushed to
[docker-brew-fedora](https://github.com/fedora-cloud/docker-brew-fedora) repository which is used to
update our images in the Docker Hub.

This cli is currently used in a [GitHub action](https://github.com/fedora-cloud/docker-brew-fedora/blob/master/.github/workflows/main.yml) define in the docker-brew-fedora repo


## Development

To start hacking on that repository you need the Rust package manager Cargo installed on your local machine.

## Clone the repository

```
$ git clone https://github.com/fedora-cloud/fedora-container-release.git
$ cd fedora-container-release
```

## Run the application

```
$ cargo run -- --release 33
```

## Build a release binary

```
$ cargo build --release
$ ll target/release/fedora-container-release
$ target/release/fedora-container-release --help
fedora-container-release 0.1.0
USAGE:
fedora-container-release --release <release>
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-r, --release <release>
```

0 comments on commit 5e24937

Please sign in to comment.