Skip to content

ci: Update build tools etc. #1247

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.

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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) .

6 changes: 3 additions & 3 deletions .github/workflows/python.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 7 additions & 7 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Build image
FROM python:3.11
FROM python:3.13

LABEL description="dcrdocs build"
LABEL version="1.0"
LABEL maintainer "[email protected]"
LABEL maintainer="[email protected]"

USER root
WORKDIR /root
Expand All @@ -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 "[email protected]"
LABEL maintainer="[email protected]"

COPY conf/nginx.conf /etc/nginx/conf.d/default.conf

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion bin/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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 "==================="
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -276,4 +276,4 @@ nav:
- 'Glossary': 'glossary.md'
- About:
- 'License': 'about/license.md'
copyright: If you wish to improve this site, please <a href="https://github.com/decred/dcrdocs/issues/new">open an issue</a> or <a href="https://github.com/decred/dcrdocs/compare">send a pull request</a>.<br />dcrdocs v0.0.3. Decred Project 2016-2024.
copyright: If you wish to improve this site, please <a href="https://github.com/decred/dcrdocs/issues/new">open an issue</a> or <a href="https://github.com/decred/dcrdocs/compare">send a pull request</a>.<br />dcrdocs v0.0.3. Decred Project 2016-2025.
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
mkdocs-material==9.5.21
mkdocs-material==9.6.11
mkdocs-markdownextradata-plugin==0.2.5