Merge branch 'main' into miketheman/blog-stuff

Author: miketheman

.git-blame-ignore-revs

@@ -0,0 +1,5 @@
+# .git-blame-ignore-revs
+# Reformatted codebase with black (#3367)
+40fbc32fef7c7ffe41cd18f3f8951578555db1aa
+# Collapsed license headers across codebase (#18217)
+f59df186dc62274b5831a72f639a1e92bbe3f94c

.github/workflows/codeql-analysis.yml

@@ -54,7 +54,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@60168efe1c415ce0f5521ea06d5c2062adbeed1b # v3.28.17
+      uses: github/codeql-action/init@ff0a06e83cb2de871e5a09832bc6a81e7276941f # v3.28.18
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -68,7 +68,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@60168efe1c415ce0f5521ea06d5c2062adbeed1b # v3.28.17
+      uses: github/codeql-action/autobuild@ff0a06e83cb2de871e5a09832bc6a81e7276941f # v3.28.18
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -81,6 +81,6 @@ jobs:
     #   ./location_of_script_within_repo/buildscript.sh
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@60168efe1c415ce0f5521ea06d5c2062adbeed1b # v3.28.17
+      uses: github/codeql-action/analyze@ff0a06e83cb2de871e5a09832bc6a81e7276941f # v3.28.18
       with:
         category: "/language:${{matrix.language}}"

.github/workflows/zizmor.yml

@@ -28,7 +28,7 @@ jobs:
       - name: Run zizmor
         run: pipx run zizmor --format sarif . > results.sarif
       - name: Upload SARIF file
-        uses: github/codeql-action/upload-sarif@60168efe1c415ce0f5521ea06d5c2062adbeed1b # v3.28.17
+        uses: github/codeql-action/upload-sarif@ff0a06e83cb2de871e5a09832bc6a81e7276941f # v3.28.18
         with:
           # Path to SARIF file relative to the root of the repository
           sarif_file: results.sarif

Dockerfile

@@ -3,7 +3,7 @@ ARG PYTHON_IMAGE_VERSION=3.13.2-slim-bookworm
 
 # First things first, we build an image which is where we're going to compile
 # our static assets with. We use this stage in development.
-FROM node:24.0.1-bookworm AS static-deps
+FROM node:24.1.0-bookworm AS static-deps
 
 WORKDIR /opt/warehouse/src/
 

babel.config.js

@@ -1,15 +1,4 @@
-/* Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+/* SPDX-License-Identifier: Apache-2.0 */
 
 module.exports = {
   presets: [['@babel/preset-env', {targets: {node: 'current'}}]],

bin/depchecker.py

@@ -1,14 +1,4 @@
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.import sys
+# SPDX-License-Identifier: Apache-2.0
 
 import sys
 

bin/licenses

@@ -9,7 +9,9 @@ for fn in $(find . -type f \( \
             -name "*.scss" -o \
           ! -name "*.min.js" \
             -name "*.js" \) \
+          ! -path "./.cache*" \
           ! -path "./.state*" \
+          ! -path "./.venv*" \
           ! -path "./docs*" \
           ! -path "./htmlcov*" \
           ! -path "./node_modules*" \
@@ -18,7 +20,7 @@ for fn in $(find . -type f \( \
           ! -path "./warehouse/static/html*" \
           ! -path "./warehouse/static/js/vendor*"); do
     # Check for license in first 5 lines (allows for shebang, encoding and handles comment character in various languages)
-    if [[ ! "$(head -5 $fn | grep "^ *\(#\|\*\|\/\/\) .* License\(d*\)")" ]]; then
+    if [[ ! "$(head -5 $fn | grep "^ *\(#\|\*\|\/\/\|\/\*\|{#\).*License")" ]]; then
         echo $fn is missing a license
         EXIT_CODE=1
     fi

dev/compose/opensearch/Dockerfile

@@ -1,4 +1,4 @@
-FROM opensearchproject/opensearch:2.12.0
+FROM opensearchproject/opensearch:2.13.0
 
 RUN opensearch-plugin remove opensearch-skills --purge
 RUN opensearch-plugin remove opensearch-ml --purge

dev/flake8/checkers.py

@@ -1,14 +1,4 @@
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
+# SPDX-License-Identifier: Apache-2.0
 
 """
 Warehouse Flake8 Local Checkers

dev/notdatadog.py

@@ -1,14 +1,4 @@
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
+# SPDX-License-Identifier: Apache-2.0
 
 import asyncio
 import asyncudp

docker-compose.yml

@@ -11,7 +11,7 @@ volumes:
 
 services:
   db:
-    image: postgres:16.1
+    image: postgres:16.4
     ports:
       # 5432 may already in use by another PostgreSQL on host
       - "5433:5432"
@@ -226,7 +226,7 @@ services:
       - caches:/opt/warehouse/src/.stylelintcache
 
   maildev:
-    image: maildev/maildev:2.1.0
+    image: maildev/maildev:2.2.1
     ports:
       - "1080:1080"
       - "1025:1025"

docs/dev/conf.py

@@ -1,15 +1,5 @@
 #!/usr/bin/env python3
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
+# SPDX-License-Identifier: Apache-2.0
 
 import os
 from datetime import datetime

docs/dev/development/documentation.rst

@@ -0,0 +1,126 @@
+#############
+Documentation
+#############
+
+Developer documentation
+=======================
+
+The developer documentation is hosted at `warehouse.pypa.io`_. It's written in
+`reStructuredText`_ or `Markdown`_ (via `MyST`_) and built using
+`Sphinx`_.
+
+.. _warehouse.pypa.io: https://warehouse.pypa.io
+.. _reStructuredText: https://docutils.sourceforge.io/rst.html
+.. _Markdown: https://www.markdownguide.org/
+.. _MyST: https://myst-parser.readthedocs.io/en/latest/
+.. _Sphinx: https://www.sphinx-doc.org/
+
+.. _dev-docs-layout:
+
+Layout
+------
+
+The developer documentation is located in the ``docs/dev`` directory.
+
+.. _dev-docs-local-dev:
+
+Local development
+-----------------
+
+To run a single local build of the dev docs, you can use the ``dev-docs``
+Makefile target:
+
+.. code-block:: console
+
+    make dev-docs
+
+That will produce a local build under ``docs/dev/_build/``.
+
+To run a local development server, you can use ``docker compose``:
+
+.. code-block:: console
+
+    docker compose up dev-docs
+
+Once running, you can visit a local build of the pages at `localhost:10002`_.
+
+.. _localhost\:10002: http://localhost:10002
+
+User documentation
+==================
+
+The user documentation is hosted at `docs.pypi.org`_. It's written in
+`Markdown`_ and built using `MkDocs`_.
+
+.. _docs.pypi.org: https://docs.pypi.org
+.. _MkDocs: https://www.mkdocs.org/
+
+.. _user-docs-layout:
+
+Layout
+------
+
+The user documentation is located in the ``docs/user`` directory.
+
+.. _user-docs-local-dev:
+
+Local development
+-----------------
+
+To run a single local build of the user docs, you can use the ``user-docs``
+Makefile target:
+
+.. code-block:: console
+
+    make user-docs
+
+That will produce a local build under ``docs/user-site/``.
+
+To run a local development server, you can use ``docker compose``:
+
+.. code-block:: console
+
+    docker compose up user-docs
+
+Once running, you can visit a local build of the user documentation at `localhost:10000`_.
+
+.. _localhost\:10000: http://localhost:10000
+
+PyPI blog
+=========
+
+The PyPI blog is hosted at `blog.pypi.org`_. Like the user documentation,
+it's written in `Markdown`_ and built using `MkDocs`_.
+
+.. _blog.pypi.org: https://blog.pypi.org
+
+.. _blog-layout:
+
+Layout
+------
+
+The blog is located in the ``docs/blog`` directory.
+
+.. _blog-local-dev:
+
+Local development
+-----------------
+
+To run a single local build of the blog, you can use the ``blog``
+Makefile target:
+
+.. code-block:: console
+
+    make blog
+
+That will produce a local build under ``docs/blog-site/``.
+
+To run a local development server, you can use ``docker compose``:
+
+.. code-block:: console
+
+    docker compose up blog
+
+Once running, you can visit a local build of the blog at `localhost:10001`_.
+
+.. _localhost\:10001: http://localhost:10001

docs/dev/development/getting-started.rst

@@ -536,6 +536,21 @@ Errors when executing ``make initdb``
   opensearch wants a lot of memory (Dustin gives warehouse ~4GB locally).
   Refer to the tip under :ref:`running-warehouse-containers` section for more details.
 
+* If ``make initdb`` fails with an error like::
+
+    A fatal error has been detected by the Java Runtime Environment:
+    SIGILL (0x4) at pc=0x0000f819dfc67c5c, pid=25, tid=26
+
+  while building the ``warehouse-opensearch`` image, this is a known issue
+  with OpenSearch in Apple M4 processors. A workaround (described in
+  `this comment <https://github.com/elastic/elasticsearch/issues/118583#issuecomment-2567270484>`_)
+  is to add the following line to ``dev/compose/opensearch/Dockerfile.yml`` (after
+  the FROM line):
+
+  .. code-block:: docker
+
+     ENV _JAVA_OPTIONS=-XX:UseSVE=0
+
 
 "no space left on device" when using ``docker compose``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -747,38 +762,6 @@ formatting and linting. You can reformat with:
 
     make reformat
 
-.. _build-docs:
-
-Building documentation
-----------------------
-
-The Warehouse documentation is stored in the :file:`docs/`
-directory with three subdirectories: blog, dev and user.
-Development docs (in the dev directory) are written in
-`reStructured Text`_ and rendered using `Sphinx`_. User docs ``/user``
-are written in markdown and rendered using ``mkdocs``. The blog is
-also written in markdown.
-
-Use :command:`make` to build the documentation. For example:
-
-.. code-block:: console
-
-    make user-docs dev-docs
-
-The HTML index for the user documentation can now be found at
-:file:`docs/user-site/index.html`, and the index for the developer
-documentation at :file:`docs/dev/_build/html/index.html`.
-
-Building the docs requires Python 3.8. If it is not installed, the
-:command:`make` command will give the following error message:
-
-.. code-block:: console
-
-  make: python3.8: Command not found
-  Makefile:53: recipe for target '.state/env/pyvenv.cfg' failed
-  make: *** [.state/env/pyvenv.cfg] Error 127
-
-
 .. _building-translations:
 
 Building translations

docs/dev/development/index.rst

@@ -38,6 +38,7 @@ Get involved or find help using:
     cloud
     email
     token-scanning
+    documentation
 
 .. _`GitHub`: https://github.com/pypi/warehouse
 .. _`"What to put in your bug report"`: https://www.contribution-guide.org/#what-to-put-in-your-bug-report

docs/dev/development/submitting-patches.rst

@@ -34,17 +34,7 @@ Every code file must start with the boilerplate licensing notice:
 
 .. code-block:: python
 
-    # Licensed under the Apache License, Version 2.0 (the "License");
-    # you may not use this file except in compliance with the License.
-    # You may obtain a copy of the License at
-    #
-    # http://www.apache.org/licenses/LICENSE-2.0
-    #
-    # Unless required by applicable law or agreed to in writing, software
-    # distributed under the License is distributed on an "AS IS" BASIS,
-    # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-    # See the License for the specific language governing permissions and
-    # limitations under the License.
+    # SPDX-License-Identifier: Apache-2.0
 
 You can view :doc:`patterns` to see more patterns that should be used within
 Warehouse.