cleanup / notes

Author: syphar

Justfile

@@ -1,5 +1,22 @@
 set shell := ["bash", "-Eeuo", "pipefail", "-c"]
 set ignore-comments
+set dotenv-load := true
+set dotenv-override := true
+
+# some environment variables that are needed for _local_ commands
+# these are defaults that can be overwritten in your local .env file
+export DOCSRS_INCLUDE_DEFAULT_TARGETS := env("DOCSRS_INCLUDE_DEFAULT_TARGETS", "false")
+export DOCSRS_LOG := env("DOCSRS_LOG", "docs_rs=debug,rustwide=info")
+export RUST_BACKTRACE := env("RUST_BACKTRACE", "1")
+export DOCSRS_PREFIX := env("DOCSRS_PREFIX", "ignored/cratesfyi-prefix")
+
+# database & s3 settings for local testing, to connect to the DB & S3/minio instance 
+# configured in docker-compose.yml
+export DOCSRS_DATABASE_URL := env("DOCSRS_DATABASE_URL", "postgresql://cratesfyi:password@localhost:15432")
+export AWS_ACCESS_KEY_ID := env("AWS_ACCESS_KEY_ID", "cratesfyi")
+export AWS_SECRET_ACCESS_KEY := env("AWS_SECRET_ACCESS_KEY", "secret_key")
+export S3_ENDPOINT := env("S3_ENDPOINT", "http://localhost:9000")
+
 
 # List available commands
 _default:
@@ -9,3 +26,6 @@ import 'justfiles/cli.just'
 import 'justfiles/utils.just'
 import 'justfiles/services.just'
 import 'justfiles/testing.just'
+
+psql:
+  psql $DOCSRS_DATABASE_URL

NOTES.md

@@ -17,6 +17,11 @@
 - unsure if the prefix mount should also be a docker volume, for performance.
   Not sure how often we actually have to look at the contents?
 
+- no apt-get upgrade in docker build, typically you should rely on the
+  base-image to be up-to-date. Rebuild every night.
+- focus right now: docker images for production and local manual testing
+- not yet: running build-tests locally
+
 ## TODO
 
 - what is better, buildx cache mounts or just layer caching?

dockerfiles/Dockerfile

@@ -105,7 +105,6 @@ RUN apt-get update \
 
 WORKDIR /srv/docsrs
 
-# Tini is a small init binary to properly handle signals
 ENTRYPOINT ["/usr/bin/tini", "/usr/local/bin/cratesfyi", "--"]
 CMD ["start-web-server", "0.0.0.0:3000"]
 
@@ -141,7 +140,6 @@ RUN apt-get update \
     && apt-get clean \
     && rm -rf /var/lib/apt/lists/*
 
-# Tini is a small init binary to properly handle signals
 ENTRYPOINT ["/usr/bin/tini", "/usr/local/bin/cratesfyi", "--"]
 CMD ["start-build-server", "0.0.0.0:3000"]
 
@@ -167,7 +165,6 @@ RUN apt-get update \
     && apt-get clean \
     && rm -rf /var/lib/apt/lists/*
 
-# Tini is a small init binary to properly handle signals
 ENTRYPOINT ["/usr/bin/tini", "/usr/local/bin/cratesfyi", "--"]
 CMD ["start-registry-watcher", "0.0.0.0:3000", "--repository-stats-updater=enabled", "--cdn-invalidator=enabled", "--queue-rebuilds=enabled"]
 

justfiles/testing.just

@@ -1,21 +1,4 @@
 # just commands for CI & local development
-set dotenv-load := true
-set dotenv-override := true
-
-# some environment variables that are needed for _local_ commands
-# these are defaults that can be overwritten in your local .env file
-export DOCSRS_INCLUDE_DEFAULT_TARGETS := env("DOCSRS_INCLUDE_DEFAULT_TARGETS", "false")
-export DOCSRS_LOG := env("DOCSRS_LOG", "docs_rs=debug,rustwide=info")
-export RUST_BACKTRACE := env("RUST_BACKTRACE", "1")
-export DOCSRS_PREFIX := env("DOCSRS_PREFIX", "ignored/cratesfyi-prefix")
-
-# database & s3 settings for local testing, to connect to the DB & S3/minio instance 
-# configured in docker-compose.yml
-export DOCSRS_DATABASE_URL := env("DOCSRS_DATABASE_URL", "postgresql://cratesfyi:password@localhost:15432")
-export AWS_ACCESS_KEY_ID := env("AWS_ACCESS_KEY_ID", "cratesfyi")
-export AWS_SECRET_ACCESS_KEY := env("AWS_SECRET_ACCESS_KEY", "secret_key")
-export S3_ENDPOINT := env("S3_ENDPOINT", "http://localhost:9000")
-
 
 [group('testing')]
 [group('sqlx')]