Skip to content

Add alternate container engine support to Justfile #7374

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chris-t-jansen wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Add alternate container engine support to Justfile #7374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7945716
Update justfile
chris-t-jansen Dec 9, 2025
3541d52
Added script attribute
chris-t-jansen Dec 9, 2025
1b3c800
Removed optimize email script
chris-t-jansen Dec 9, 2025
573494e
Added parameter to optimize email recipe
chris-t-jansen Dec 9, 2025
3af8caa
Merge branch 'main' into podman-support
chris-t-jansen Jan 8, 2026
03f531a
Merge branch 'main' into podman-support
chris-t-jansen Jan 9, 2026
9eda039
Updated build instructions in README
chris-t-jansen Jan 11, 2026
ec0ffff
Merge branch 'rust-lang:main' into podman-support
chris-t-jansen Jan 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,17 +185,13 @@ Use the included `new_contribs.sh` script:

## Building

To ensure consistency across development setups, we use a
[Docker](https://www.docker.com) container-based workflow for building the
website and email newsletter. Similarly, we use [Just](https://just.systems/) to
ensure you have Docker installed on your system if you intend to build the
website or email newsletter.
To ensure consistency across development setups, we use a container-based workflow for building the website and email newsletter. [Docker](https://www.docker.com) is used by default, but you can use any drop-in Docker replacement, such as [Podman](https://podman.io/).

Similarly, we use [Just](https://just.systems/) to ensure you have Docker or a suitable alternative installed on your system, as well as to run the various commands necessary to build the website or email newsletter.

### Install Just

To install Just you have
[many options](https://just.systems/man/en/packages.html); we recommend using
Cargo:
To install Just you have [many options](https://just.systems/man/en/packages.html); we recommend using Cargo:

```sh
cargo install just
Expand All @@ -205,8 +201,7 @@ cargo install just

> [!IMPORTANT]
>
> Before attempting to build the website, ensure Docker is in a running state on
> your system.
> Before attempting to build the website, ensure Docker or a suitable alternative is running on your system.

- Enter the `publishing/` directory:

Expand All @@ -220,35 +215,40 @@ cd publishing
just website
```

- View the website locally at default
[http://localhost:8000](http://localhost:8000), or specific posts at
`http://localhost:8000/blog/{YEAR}/{MONTH}/{DAY}/{ISSUE}/`
- To use a container engine besides Docker, append the appropriate command at the end:

```sh
just website podman
```

- View the website locally at default <http://localhost:8000>, or specific posts at `http://localhost:8000/blog/{YEAR}/{MONTH}/{DAY}/{ISSUE}/`

> [!NOTE]
>
> If looking to test the website's search functionality locally, you will need
> to adjust the
> [`TESTING_LOCALLY`](https://github.com/rust-lang/this-week-in-rust/blob/dc127f17fcabbf0f058eb3d5a3febba434ddca83/pelicanconf.py#L7)
> variable to `True`.
> If looking to test the website's internal links locally, you will need to adjust the [`TESTING_LOCALLY`](https://github.com/rust-lang/this-week-in-rust/blob/dc127f17fcabbf0f058eb3d5a3febba434ddca83/pelicanconf.py#L7) variable to `True`.

### Building the newsletter

> [!IMPORTANT]
>
> Before attempting to build the website, ensure Docker is in a running state on
> your system.
> Before attempting to build the newsletter, ensure Docker or a suitable alternative is running on your system.

- Enter the `publishing/` directory:

```sh
cd publishing
```

- Run the Docker build and website local-host command:
- Run the Docker build and newsletter generation command:

```sh
just email
```

- View the email newsletter formatting of specific posts at
`http://localhost:8000/blog/{YEAR}/{MONTH}/{DAY}/{ISSUE}/`
- To use a container engine besides Docker, append the appropriate command at the end:

```sh
just email podman
```

- View the email newsletter formatting of most recent issue at `publishing/email/{ISSUE}.html`, or view the formatting of a specific issue at `publishing/output-email-format/blog/{YEAR}/{MONTH}/{DAY}/{ISSUE}/index.html`.
28 changes: 0 additions & 28 deletions publishing/create_optimized_email.sh
View file
Open in desktop

This file was deleted.

61 changes: 47 additions & 14 deletions publishing/justfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,23 @@ help:
# Output: `email/<NUMBER>-<YEAR>-<MONTH>-<DAY>-email.html`
#

set unstable

default-container-engine := "docker"

# Generate and host website locally
website: generate-website host-website
website container-engine=default-container-engine: (generate-website container-engine) (host-website container-engine)

# Copy website contents to this-week-in-rust.github.io repo
copy-website-contents:
./copy_website_content_to_repo.sh

# Generate and optimize email template
email: generate-email optimize-email
email container-engine=default-container-engine: (generate-email container-engine) (optimize-email container-engine)

# Build Docker image
docker-build:
cd .. && docker build -t twir -f publishing/Dockerfile . && cd -
# Build container engine image (Docker by default)
container-build container-engine=default-container-engine:
cd .. && {{container-engine}} build -t twir -f publishing/Dockerfile . && cd -

# Clean website output directories
clean-website:
Expand All @@ -59,17 +63,18 @@ clean-email:
rm -rf output/ output-email-format/ email/ juice/

# Generate website content
generate-website: docker-build clean-website
generate-website container-engine=default-container-engine: (container-build container-engine) clean-website
@echo "Generating website..."
docker run -it \
mkdir -p output-website
{{container-engine}} run -it \
-v {{justfile_directory()}}/output-website:/usr/twir/output \
twir:latest
@echo "Finished generating website."

# Host website locally on port 8000
host-website:
host-website container-engine=default-container-engine:
@echo "Hosting website..."
docker run -it \
{{container-engine}} run -it \
-p 8000:8000 \
-v {{justfile_directory()}}/output-website:/usr/twir/output:ro \
-it \
Expand All @@ -80,15 +85,43 @@ host-website:
@echo "To sync contents with your local 'this-week-in-rust.github.io' repo, run 'just copy-website-contents'"

# Generate email content
generate-email: docker-build clean-email
generate-email container-engine=default-container-engine: (container-build container-engine) clean-email
@echo "Generating email..."
mkdir -p output-email-format
docker run -it \
{{container-engine}} run -it \
-e USE_EMAIL_THEME=1 \
-v {{justfile_directory()}}/output-email-format:/usr/twir/output \
twir:latest

# Optimize email HTML for delivery
optimize-email:
@echo "Generating optimized email..."
OUTPUT_PREFIX=output-email-format ./create_optimized_email.sh
[script("bash")]
optimize-email container-engine=default-container-engine:
echo "Generating optimized email..."
OUTPUT_PREFIX="output-email-format"

source utils.sh

LOCAL_EMAIL_PREFIX="email/${LATEST_ISSUE_NUMBER}-${LATEST_YEAR}-${LATEST_MONTH}-${LATEST_DAY}"
echo "Creating email for ${LATEST_ISSUE_NUMBER}-${LATEST_YEAR}-${LATEST_MONTH}-${LATEST_DAY}"

# Prepare email directory
mkdir -p email
rm -f ${LOCAL_EMAIL_PREFIX}-in.html
cp ${LATEST_ISSUE_FULL_PATH} ${LOCAL_EMAIL_PREFIX}-in.html

{{container-engine}} run \
-v $(pwd)/email:/usr/twir/email \
-e LOCAL_EMAIL_PREFIX=${LOCAL_EMAIL_PREFIX} \
twir:latest \
bash create_html_friendly_page.sh

rm ${LOCAL_EMAIL_PREFIX}-in.html

printf "\n\n${CYAN_FONT}*****${PURPLE_FONT}*****${CYAN_FONT}*****${PURPLE_FONT}*****${NC}"
printf "\n${CYAN_FONT}*****${PURPLE_FONT}*****${CYAN_FONT}*****${PURPLE_FONT}*****${NC}"
printf "\n${CYAN_FONT}*****${PURPLE_FONT}*****${CYAN_FONT}*****${PURPLE_FONT}*****${NC}"
printf "\n📧 HEY TWiR PUBLISHER..."
printf "\nLatest email template found at: ${YELLOW_FONT}'$(pwd)/${LOCAL_EMAIL_PREFIX}-email.html'${NC}"
printf "\n${CYAN_FONT}*****${PURPLE_FONT}*****${CYAN_FONT}*****${PURPLE_FONT}*****${NC}"
printf "\n${CYAN_FONT}*****${PURPLE_FONT}*****${CYAN_FONT}*****${PURPLE_FONT}*****${NC}"
printf "\n${CYAN_FONT}*****${PURPLE_FONT}*****${CYAN_FONT}*****${PURPLE_FONT}*****${NC}\n\n"