From f719915790c71ec90ea067a683003e6f084ce76e Mon Sep 17 00:00:00 2001 From: jholdstock Date: Tue, 1 Apr 2025 16:27:18 +0100 Subject: [PATCH] ci: Update build tools etc. python 3.13 mkdocs 9.6.11 nginx 1.26 --- .github/workflows/docker.yml | 2 +- .github/workflows/python.yml | 6 +++--- Dockerfile | 14 +++++++------- LICENSE | 2 +- README.md | 4 ++-- bin/build.sh | 4 +++- mkdocs.yml | 2 +- requirements.txt | 2 +- 8 files changed, 19 insertions(+), 17 deletions(-) diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index bd76fbce2..405366cd2 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -5,7 +5,7 @@ jobs: build: runs-on: ubuntu-latest steps: - - uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 - name: Build the Docker image run: docker build -t decred/dcrdocs:$(date +%s) . diff --git a/.github/workflows/python.yml b/.github/workflows/python.yml index 0724a0e40..4958e4223 100644 --- a/.github/workflows/python.yml +++ b/.github/workflows/python.yml @@ -6,12 +6,12 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - python-version: [3.11] + python-version: [3.13] steps: - - uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5 + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5.1.0 + uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0 with: python-version: ${{ matrix.python-version }} - name: Install dependencies diff --git a/Dockerfile b/Dockerfile index 12299fd75..8d418bae1 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,9 +1,9 @@ # Build image -FROM python:3.11 +FROM python:3.13 LABEL description="dcrdocs build" LABEL version="1.0" -LABEL maintainer "jholdstock@decred.org" +LABEL maintainer="jholdstock@decred.org" USER root WORKDIR /root @@ -17,20 +17,20 @@ RUN pip install mkdocs && \ # Install dependencies for generating social cards. # https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards -RUN apt update && \ - apt install -y libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev && \ +RUN apt-get update && \ + apt-get install -y libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev && \ pip install pillow cairosvg -ENV DCRDOCS_CARDS true +ENV DCRDOCS_CARDS="true" RUN ./bin/build_docs.sh # Serve image (stable nginx version) -FROM nginx:1.24-alpine +FROM nginx:1.26-alpine LABEL description="dcrdocs serve" LABEL version="1.0" -LABEL maintainer "jholdstock@decred.org" +LABEL maintainer="jholdstock@decred.org" COPY conf/nginx.conf /etc/nginx/conf.d/default.conf diff --git a/LICENSE b/LICENSE index e609e06ca..2e8823c0e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ ISC License -Copyright (c) 2018-2024 The Decred developers +Copyright (c) 2018-2025 The Decred developers Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above diff --git a/README.md b/README.md index ee3ace244..cfe3ad5cc 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,8 @@ In order to develop on `dcrdocs` you will need [Python](https://www.python.org/) installed on your system. -Version 3.9 is recommended because this is the version used by the live site, -however MkDocs does also support versions 3.6 and later. +Version 3.13 is recommended because this is the version used by the live site, +however MkDocs does also support versions 3.8 and later. Python 2 is not supported. You can verify your installation of Python by checking the output from these two diff --git a/bin/build.sh b/bin/build.sh index 3a2a89939..ae45f11bc 100755 --- a/bin/build.sh +++ b/bin/build.sh @@ -15,7 +15,9 @@ if [ "$1" != "" ]; then IMAGE_NAME=$1 fi -docker build -t $IMAGE_NAME . +# The default logging of the docker builder folds output which can hide +# important DEBUG/INFO messages. Use --progress==plain to prevent this. +docker build --progress=plain -t $IMAGE_NAME . echo "" echo "===================" diff --git a/mkdocs.yml b/mkdocs.yml index a9e1bfe48..ab37f05d8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -276,4 +276,4 @@ nav: - 'Glossary': 'glossary.md' - About: - 'License': 'about/license.md' -copyright: If you wish to improve this site, please open an issue or send a pull request.
dcrdocs v0.0.3. Decred Project 2016-2024. +copyright: If you wish to improve this site, please open an issue or send a pull request.
dcrdocs v0.0.3. Decred Project 2016-2025. diff --git a/requirements.txt b/requirements.txt index 4f7d9f716..589436640 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,2 @@ -mkdocs-material==9.5.21 +mkdocs-material==9.6.11 mkdocs-markdownextradata-plugin==0.2.5