Merge branch 'add-code-style-checks' of https://github.com/nexB/skeleton

into add-code-style-checks

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Author: pombredanne

README.rst

@@ -14,6 +14,7 @@ Usage
 
 A brand new project
 -------------------
+
 .. code-block:: bash
 
     git init my-new-repo
@@ -27,6 +28,7 @@ From here, you can make the appropriate changes to the files for your specific p
 
 Update an existing project
 ---------------------------
+
 .. code-block:: bash
 
     cd my-existing-project
@@ -42,10 +44,49 @@ More usage instructions can be found in ``docs/skeleton-usage.rst``.
 Release Notes
 =============
 
+- 2025-03-31:
+
+    - Use ruff as the main code formatting tool, add ruff rules to pyproject.toml
+
+- 2025-03-29:
+
+    - Add support for beta macOS-15
+    - Add support for beta windows-2025
+
+- 2025-02-14:
+
+    - Drop support for Python 3.8, add support in CI for Python 3.13, use Python 3.12 as default
+      version.
+
+- 2025-01-17:
+
+    - Drop support for macOS-12, add support for macOS-14
+    - Add support in CI for ubuntu-24.04
+    - Add support in CI for Python 3.12
+
+- 2024-08-20:
+
+    - Update references of ownership from nexB to aboutcode-org
+
+- 2024-07-01:
+
+    - Drop support for Python 3.8
+    - Drop support for macOS-11, add support for macOS-14
+
+- 2024-02-19:
+
+    - Replace support in CI of default ubuntu-20.04 by ubuntu-22.04
+
+- 2023-10-18:
+
+    - Add dark mode support in documentation
+
 - 2023-07-18:
+
     - Add macOS-13 job in azure-pipelines.yml
 
 - 2022-03-04:
+
     - Synchronize configure and configure.bat scripts for sanity
     - Update CI operating system support with latest Azure OS images
     - Streamline utility scripts in etc/scripts/ to create, fetch and manage third-party

azure-pipelines.yml

@@ -26,11 +26,27 @@ jobs:
     - template: etc/ci/azure-posix.yml
       parameters:
           job_name: macos13_cpython
+          image_name: macOS-13-xlarge
+          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
+          test_suites:
+              all: venv/bin/pytest -n 2 -vvs
+
+    - template: etc/ci/azure-posix.yml
+      parameters:
+          job_name: macos13_cpython_arm64
           image_name: macOS-13
           python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
           test_suites:
               all: venv/bin/pytest -n 2 -vvs
 
+    - template: etc/ci/azure-posix.yml
+      parameters:
+          job_name: macos14_cpython
+          image_name: macOS-14-large
+          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
+          test_suites:
+              all: venv/bin/pytest -n 2 -vvs
+
     - template: etc/ci/azure-posix.yml
       parameters:
           job_name: macos14_cpython_arm64
@@ -41,8 +57,16 @@ jobs:
 
     - template: etc/ci/azure-posix.yml
       parameters:
-          job_name: macos14_cpython
-          image_name: macOS-14-large
+          job_name: macos15_cpython
+          image_name: macOS-15
+          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
+          test_suites:
+              all: venv/bin/pytest -n 2 -vvs
+
+    - template: etc/ci/azure-posix.yml
+      parameters:
+          job_name: macos15_cpython_arm64
+          image_name: macOS-15-large
           python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
           test_suites:
               all: venv/bin/pytest -n 2 -vvs
@@ -62,3 +86,11 @@ jobs:
           python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
           test_suites:
               all: venv\Scripts\pytest -n 2 -vvs
+
+    - template: etc/ci/azure-win.yml
+      parameters:
+          job_name: win2025_cpython
+          image_name: windows-2025
+          python_versions: ['3.9', '3.10', '3.11', '3.12', '3.13']
+          test_suites:
+              all: venv\Scripts\pytest -n 2 -vvs

docs/Makefile

@@ -7,7 +7,7 @@ SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
 SPHINXAUTOBUILD = sphinx-autobuild
 SOURCEDIR     = source
-BUILDDIR      = build
+BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".
 help:

etc/scripts/update_skeleton.py

@@ -0,0 +1,103 @@
+#!/usr/bin/env python
+#
+# Copyright (c) nexB Inc. AboutCode, and others. All rights reserved.
+# ScanCode is a trademark of nexB Inc.
+# SPDX-License-Identifier: Apache-2.0
+# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
+# See https://github.com/aboutcode-org/skeleton for support or download.
+# See https://aboutcode.org for more information about nexB OSS projects.
+#
+
+from pathlib import Path
+import os
+import subprocess
+
+import click
+
+
+ABOUTCODE_PUBLIC_REPO_NAMES=[
+    "aboutcode-toolkit",
+    "ahocode",
+    "bitcode",
+    "clearcode-toolkit",
+    "commoncode",
+    "container-inspector",
+    "debian-inspector",
+    "deltacode",
+    "elf-inspector",
+    "extractcode",
+    "fetchcode",
+    "gemfileparser2",
+    "gh-issue-sandbox",
+    "go-inspector",
+    "heritedcode",
+    "license-expression",
+    "license_copyright_pipeline",
+    "nuget-inspector",
+    "pip-requirements-parser",
+    "plugincode",
+    "purldb",
+    "pygmars",
+    "python-inspector",
+    "sanexml",
+    "saneyaml",
+    "scancode-analyzer",
+    "scancode-toolkit-contrib",
+    "scancode-toolkit-reference-scans",
+    "thirdparty-toolkit",
+    "tracecode-toolkit",
+    "tracecode-toolkit-strace",
+    "turbo-spdx",
+    "typecode",
+    "univers",
+]
+
+
+@click.command()
+@click.help_option("-h", "--help")
+def update_skeleton_files(repo_names=ABOUTCODE_PUBLIC_REPO_NAMES):
+    """
+    Update project files of AboutCode projects that use the skeleton
+
+    This script will:
+    - Clone the repo
+    - Add the skeleton repo as a new origin
+    - Create a new branch named "update-skeleton-files"
+    - Merge in the new skeleton files into the "update-skeleton-files" branch
+
+    The user will need to save merge commit messages that pop up when running
+    this script in addition to resolving the merge conflicts on repos that have
+    them.
+    """
+
+    # Create working directory
+    work_dir_path = Path("/tmp/update_skeleton/")
+    if not os.path.exists(work_dir_path):
+        os.makedirs(work_dir_path, exist_ok=True)
+
+    for repo_name in repo_names:
+        # Move to work directory
+        os.chdir(work_dir_path)
+
+        # Clone repo
+        repo_git = f"git@github.com:aboutcode-org/{repo_name}.git"
+        subprocess.run(["git", "clone", repo_git])
+
+        # Go into cloned repo
+        os.chdir(work_dir_path / repo_name)
+
+        # Add skeleton as an origin
+        subprocess.run(["git", "remote", "add", "skeleton", "git@github.com:aboutcode-org/skeleton.git"])
+
+        # Fetch skeleton files
+        subprocess.run(["git", "fetch", "skeleton"])
+
+        # Create and checkout new branch
+        subprocess.run(["git", "checkout", "-b", "update-skeleton-files"])
+
+        # Merge skeleton files into the repo
+        subprocess.run(["git", "merge", "skeleton/main", "--allow-unrelated-histories"])
+
+
+if __name__ == "__main__":
+    update_skeleton_files()

tests/test_skeleton_codestyle.py

@@ -23,7 +23,7 @@ def test_skeleton_codestyle(self):
             return
 
         commands = [
-            ["venv/bin/ruff", "--check"],
+            ["venv/bin/ruff", "check"],
             ["venv/bin/ruff", "format", "--check"],
         ]
         command = None