Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.54 KB

README.md

File metadata and controls

42 lines (29 loc) · 1.54 KB
Raw

Pluotos cargo-hatch template

This directory contains a cargo-hatch template for generating a Ploutos enabled Git repository. When pushed to GitHub it will trigger GitHub Actions to package a simple Hello World Rust application as DEB, RPM package(s) and/or Docker image(s) for x86_64 platforms and optionally also for other architectures.

tl;dr

cargo hatch git https://github.com/NLnetLabs/ploutos --folder template <proj_name>

Usage

The following assumes that you have already created an empty GitHub project called <org_or_user>/<proj_name>.

Tip: Do you intend to say yes when Hatch asks Publish Docker images(s) to Docker Hub? Then:

  1. Generate an access token at https://hub.docker.com/settings/security.
  2. Store it in a DOCKER_HUB_TOKEN secret in your new GitHub project at https://github.com/YOUR_ORG/YOUR_REPO/settings/secrets/actions.

First install Cargo Hatch and invoke it using the template in this repository:

cargo install cargo-hatch
cargo hatch git https://github.com/NLnetLabs/ploutos --folder template <proj_name>

Now enter the project directory that was created, generate the Cargo.lock file and commit the files to Git:

cd <proj_name>
cargo generate-lockfile
git add .gitignore .github *
git commit -m "Initial version."

And then follow the standard GitHub instructions for pushing the local Git project to GitHub:

git remote add origin git@github.com:<org_or_user>/<proj_name>.git
git branch -M main
git push --set-upstream origin main