Merge branch 'master' into fix-mutable-binheap-unions

Author: oxinabox

.github/workflows/CI.yml

@@ -5,6 +5,19 @@ on:
     branches:
       - master
     tags: '*'
+
+concurrency:
+  # group by workflow and ref; the last slightly strange component ensures that for pull
+  # requests, we limit to 1 concurrent job, but for the default repository branch we don't
+  group: ${{ github.workflow }}-${{ github.ref }}-${{ github.ref_name != github.event.repository.default_branch || github.run_number }}
+  # Cancel intermediate builds, but only if it is a pull request build.
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
+# needed to allow julia-actions/cache to delete old caches that it has created
+permissions:
+  actions: write
+  contents: read
+
 jobs:
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
@@ -13,34 +26,46 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '1.0'
+          - '1.6'
+          - 'lts'
           - '1'
 #          - 'nightly'
         os:
           - ubuntu-latest
-          - macOS-latest
+          - macos-latest
           - windows-latest
         arch:
-          - x64
+          - ''
+        exclude:
+          - os: macos-latest # Apple Silicon
+            version: '1.6'
+            arch: ''
+        include:
+          - os: macos-latest # Apple Silicon
+            version: '1.6'
+            # Install an x86_64 build of Julia, and run it under Rosetta 2 emulation
+            arch: 'x64'
     steps:
-      - uses: actions/checkout@v3
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v6
+      - uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.version }}
-          arch: ${{ matrix.arch }}
-      - uses: actions/cache@v3
-        env:
-          cache-name: cache-artifacts
-        with:
-          path: ~/.julia/artifacts
-          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
-          restore-keys: |
-            ${{ runner.os }}-test-${{ env.cache-name }}-
-            ${{ runner.os }}-test-
-            ${{ runner.os }}-
+          arch: ${{ (matrix.arch == '') && runner.arch || matrix.arch }}
+      - uses: julia-actions/cache@v2
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
+      - name: "Run doctests"
+        if: ${{ matrix.version == 'lts' }} # only run in one Julia version due to fluctuations
+        run: |
+          julia --project=docs --color=yes --code-coverage -e '
+            using Pkg
+            Pkg.develop(PackageSpec(path=pwd()))
+            Pkg.instantiate()
+            using Documenter
+            using DataStructures
+            DocMeta.setdocmeta!(DataStructures, :DocTestSetup, :(using DataStructures); recursive=true)
+            doctest(DataStructures)'
       - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v3
+      - uses: codecov/codecov-action@v5
         with:
-          file: lcov.info
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/Documenter.yml

@@ -1,18 +1,29 @@
 name: Documenter
 on:
-    push:
-        branches: [master]
-        tags: [v*]
-    pull_request:
+  push:
+    branches: [main, master]
+    tags: ["v*"]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  actions: write   # needed to allow julia-actions/cache to delete old caches that it has created
+  contents: write  # needed to allow deploying docs
+  statuses: write
 
 jobs:
-    Documenter:
-      name: Documentation
-      runs-on: ubuntu-latest
-      steps:
-          - uses: actions/checkout@v3
-          - uses: julia-actions/julia-buildpkg@latest
-          - uses: julia-actions/julia-docdeploy@latest
-            env:
-                GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-                DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+  Documenter:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1'                         # replace this with whatever version you need
+          show-versioninfo: true               # this causes versioninfo to be printed to the action log
+      - uses: julia-actions/cache@v2           # cache using https://github.com/julia-actions/cache
+      - uses: julia-actions/julia-buildpkg@v1  # if package requires Pkg.build()
+      - uses: julia-actions/julia-docdeploy@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

.github/workflows/Invalidations.yml

@@ -4,6 +4,22 @@ on:
     types:
       - created
   workflow_dispatch:
+    inputs:
+      lookback:
+        default: 3
+# permissions:
+#   actions: read
+#   checks: read
+#   contents: write
+#   deployments: read
+#   issues: read
+#   discussions: read
+#   packages: read
+#   pages: read
+#   pull-requests: read
+#   repository-projects: read
+#   security-events: read
+#   statuses: read
 jobs:
   TagBot:
     if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'

.github/workflows/TagBot.yml

@@ -4,3 +4,4 @@ docs/site/
 docs/Manifest.toml
 Manifest.toml
 benchmark/*.json
+.vscode

.gitignore

@@ -1,7 +1,95 @@
 Changelog is now in the [Github Release Notes](https://github.com/JuliaCollections/DataStructures.jl/releases).
 
+Starting from version 0.19.0, CHANGELOG.md is managed in a format that follows <https://keepachangelog.com/en/1.1.0/>.
+
+<!-- links start -->
+[Unreleased]: https://github.com/JuliaCollections/DataStructures.jl/compare/v0.19.0...HEAD
+[0.19.0]: https://github.com/JuliaCollections/DataStructures.jl/compare/v0.18.22...v0.19.0
+[0.19.1]: https://github.com/JuliaCollections/DataStructures.jl/compare/v0.19.0...v0.19.1
+[0.19.2]: https://github.com/JuliaCollections/DataStructures.jl/compare/v0.19.1...v0.19.2
+<!-- links end -->
+
+[0.19.3]
+=====================
+
+## Fixed
+
+- Reintroduce a method for `percolate_up!` `percolate_down!` that doesn't require the element to be passed, which was unintentionally removed in 0.19.2 (JuliaCollections/DataStructures.jl#960).
+
+[0.19.2]
+=====================
+
+## Added
+
+- `percolate_up!`, `percolate_down!` now use `@propagate_inbounds` to control bounds checking (JuliaCollections/DataStructures.jl#954)
+
+[0.19.1] - 2025-08-26
+=====================
+
+## Fixed
+
+- Add `newsz::Integer` type annotation to `sizehint!` overloads (JuliaCollections/DataStructures.jl#945)
+- Fix `pop!` with default for `OrderedRobinDict` (JuliaCollections/DataStructures.jl#950)
+- Fix deprecation of `DisjointSets(xs...)` to avoid warning on package load (JuliaCollections/DataStructures.jl#951)
+
+## Other
+
+- link to where missing change notes are (JuliaCollections/DataStructures.jl#944)
+- Bump `actions/checkout` from 4 to 5 (JuliaCollections/DataStructures.jl#947)
+- Add docstrings to `DefaultDict` (JuliaCollections/DataStructures.jl#948)
+
+[0.19.0] - 2025-07-31
+=====================
+
+## Added
+- New `Queue` and `Stack` as separate types with enhanced documentation
+- Add `empty!` method for heaps (JuliaCollections/DataStructures.jl#932)
+- Support for recursive `DefaultDict` creation
+- Add `find_prefixes` method to `Trie` for finding all keys that are prefixes of a given string (JuliaCollections/DataStructures.jl#933)
+- Improved constructors for `CircularBuffer` allowing initialization with an iterable and capacity
+- Add `resize!` method for `CircularBuffer`
+- Enhanced documentation with doctests and improved examples throughout (JuliaCollections/DataStructures.jl#931)
+
+## Changed
+- Minimum Julia version requirement raised to 1.6 (JuliaCollections/DataStructures.jl#874)
+- `DisjointSets` renamed to `DisjointSet` (singular form) (JuliaCollections/DataStructures.jl#700)
+- `IntDisjointSets` renamed to `IntDisjointSet` (singular form) (JuliaCollections/DataStructures.jl#700)
+- PriorityQueue API updated to use standard Julia interfaces:
+  - `enqueue!` → `push!`
+  - `dequeue!` → `popfirst!`
+  - `dequeue_pair!` → `popfirst!`
+  - `peek` → `first`
+- Renamed methods in sorted containers:
+  - `startof` → `firstindex`
+  - `endof` → `lastindex`
+  - `insert!` → `push_return_semitoken!`
+- `Accumulator` constructor behavior changed to properly accumulate values when initialized with pairs
+- Documentation significantly expanded and reorganized
+- Performance improvements in heaps and various other data structures (JuliaCollections/DataStructures.jl#907)
+
+## Deprecated
+- `enqueue!` and `dequeue!` methods (use `push!` and `popfirst!` instead)
+- `peek` for PriorityQueue (use `first` instead)
+- `DisjointSets` (use `DisjointSet` instead) (JuliaCollections/DataStructures.jl#700)
+- `IntDisjointSets` (use `IntDisjointSet` instead) (JuliaCollections/DataStructures.jl#700)
+- `startof` and `endof` (use `firstindex` and `lastindex` instead)
+
+## Fixed
+- Memory management improvements using `Base._unsetindex!` in several data structures (JuliaCollections/DataStructures.jl#884)
+- Fixed `append!` behavior in `MutableLinkedList` to properly handle multiple arguments
+- Various bug fixes and correctness improvements
+
+## Removed
+- Dependency on Compat.jl
+- Dependency on InteractiveUtils.jl
+- Support for Julia versions < 1.6 (JuliaCollections/DataStructures.jl#874)
+
+0.8 – 0.18
+===========
+Changelogs for 0.8 to 0.18.x are listed only on the [Github release pages](https://github.com/JuliaCollections/DataStructures.jl/releases):
+e.g.: [v0.18.22](https://github.com/JuliaCollections/DataStructures.jl/releases/tag/v0.18.22)
+
 
-## Old Changelong (pre-2018)
 
 0.7.0 / 2017-09-02
 ==================

Changelog.md CHANGELOG.mdChangelog.md renamed to CHANGELOG.md

@@ -1,16 +1,13 @@
 name = "DataStructures"
 uuid = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
-version = "0.19.0-DEV"
+version = "0.19.3"
 
 [deps]
-Compat = "34da2185-b29b-5c13-b0c7-acf172513d20"
-InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
 OrderedCollections = "bac558e1-5e72-5ebc-8fee-abe8a469f55d"
 
 [compat]
-Compat = "3.0.0, 4"
 OrderedCollections = "1.1.0"
-julia = "1"
+julia = "1.6"
 
 [extras]
 Primes = "27ebfcd6-29c5-5fa9-bf4b-fb8fc14df3ae"

Project.toml

@@ -1,5 +1,4 @@
-[![Travis Build Status](https://travis-ci.org/JuliaCollections/DataStructures.jl.svg?branch=master)](https://travis-ci.org/JuliaCollections/DataStructures.jl)
-[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/5gw9xok4e58aixsv?svg=true)](https://ci.appveyor.com/project/kmsquire/datastructures-jl)
+[![CI](https://github.com/JuliaCollections/LRUCache.jl/actions/workflows/ci.yml/badge.svg)](https://github.com/JuliaCollections/LRUCache.jl/actions/workflows/ci.yml)
 [![Test Coverage](https://coveralls.io/repos/github/JuliaCollections/DataStructures.jl/badge.svg?branch=master)](https://coveralls.io/github/JuliaCollections/DataStructures.jl?branch=master)
 [![Test Coverage](https://codecov.io/github/JuliaCollections/DataStructures.jl/coverage.svg?branch=master)](https://codecov.io/github/JuliaCollections/DataStructures.jl?branch=master)
 [![Stable Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliacollections.github.io/DataStructures.jl/stable)

README.md

@@ -4,4 +4,4 @@ DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 
 [compat]
-Documenter = "0.27"
+Documenter = "1"

docs/Project.toml

@@ -5,6 +5,8 @@ DocMeta.setdocmeta!(DataStructures, :DocTestSetup, :(using DataStructures); recu
 
 makedocs(
     sitename = "DataStructures.jl",
+    warnonly = true,  # FIXME: address all warnings and resolve them
+    doctest = true,
     pages = [
         "index.md",
         "deque.md",