refactor: rename repository to slick-queue and update references in CMake, documentation, and tests

kzhdev · kzhdev · commit 870843e08b75 · 2026-01-10T15:45:39.000-06:00
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -44,7 +44,7 @@ jobs:
 
       - name: Create header archive
         run: |
-          zip -r ./slick_queue-${{ steps.get_version.outputs.VERSION }}.zip include/
+          zip -r ./slick-queue-${{ steps.get_version.outputs.VERSION }}.zip include/
 
       - name: Create Release
         uses: softprops/action-gh-release@v1
@@ -59,4 +59,4 @@ jobs:
           prerelease: false
           generate_release_notes: false
           files: |
-            slick_queue-${{ steps.get_version.outputs.VERSION }}.zip
+            slick-queue-${{ steps.get_version.outputs.VERSION }}.zip
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,8 @@
+# v1.2.2 - 2026-01-10
+- Rename repository from slick_queue to slick-queue (hyphenated naming follows recommended convention)
+- Refactor repository name in CMake configuration files
+- Update documentation and build references to use new repository name
+
 # v1.2.1 - 2025-12-27
 - Fixed a race condition when multi-process trying to create the same shared memory segment
 - Fixed CTest integration by moving enable_testing() to root CMakeLists.txt and removing EXCLUDE_FROM_ALL
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,21 +1,23 @@
 cmake_minimum_required(VERSION 3.10)
 
-project(slick_queue
-        VERSION 1.2.1
+project(slick-queue
+        VERSION 1.2.2
         DESCRIPTION "A C++ Lock-Free MPMC queue"
         LANGUAGES CXX)
 
 set(CMAKE_CXX_STANDARD 20)
 
-add_library(slick_queue INTERFACE)
-add_library(slick::slick_queue ALIAS slick_queue)
-target_include_directories(slick_queue INTERFACE
+add_library(slick-queue INTERFACE)
+add_library(slick::queue ALIAS slick-queue)
+add_library(slick_queue ALIAS slick-queue)  # For backward compatibility with older versions
+
+target_include_directories(slick-queue INTERFACE
     $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
     $<INSTALL_INTERFACE:include>
 )
 
 if(UNIX AND NOT APPLE)
-    target_link_libraries(slick_queue INTERFACE rt atomic)
+    target_link_libraries(slick-queue INTERFACE rt atomic)
 endif()
 
 option(BUILD_SLICK_QUEUE_TESTS "Build tests" ON)
@@ -32,35 +34,35 @@ include(CMakePackageConfigHelpers)
 
 # Create the config file
 configure_package_config_file(
-    "${CMAKE_CURRENT_SOURCE_DIR}/cmake/slick_queueConfig.cmake.in"
-    "${CMAKE_CURRENT_BINARY_DIR}/slick_queueConfig.cmake"
-    INSTALL_DESTINATION lib/cmake/slick_queue
+    "${CMAKE_CURRENT_SOURCE_DIR}/cmake/slick-queueConfig.cmake.in"
+    "${CMAKE_CURRENT_BINARY_DIR}/slick-queueConfig.cmake"
+    INSTALL_DESTINATION lib/cmake/slick-queue
 )
 
 # Create the version file
 write_basic_package_version_file(
-    "${CMAKE_CURRENT_BINARY_DIR}/slick_queueConfigVersion.cmake"
+    "${CMAKE_CURRENT_BINARY_DIR}/slick-queueConfigVersion.cmake"
     VERSION ${PROJECT_VERSION}
     COMPATIBILITY SameMajorVersion
 )
 
 # Install the config files
 install(FILES
-    "${CMAKE_CURRENT_BINARY_DIR}/slick_queueConfig.cmake"
-    "${CMAKE_CURRENT_BINARY_DIR}/slick_queueConfigVersion.cmake"
-    DESTINATION lib/cmake/slick_queue
+    "${CMAKE_CURRENT_BINARY_DIR}/slick-queueConfig.cmake"
+    "${CMAKE_CURRENT_BINARY_DIR}/slick-queueConfigVersion.cmake"
+    DESTINATION lib/cmake/slick-queue
 )
 
 # Install the target
-install(TARGETS slick_queue
-    EXPORT slick_queueTargets
+install(TARGETS slick-queue
+    EXPORT slick-queueTargets
 )
 
 # Install the export set
-install(EXPORT slick_queueTargets
-    FILE slick_queueTargets.cmake
+install(EXPORT slick-queueTargets
+    FILE slick-queueTargets.cmake
     NAMESPACE slick::
-    DESTINATION lib/cmake/slick_queue
+    DESTINATION lib/cmake/slick-queue
 )
 
-message(STATUS "slick_queue: ${PROJECT_VERSION}")
+message(STATUS "slick-queue: ${PROJECT_VERSION}")
diff --git a/README.md b/README.md
@@ -4,8 +4,8 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Header-only](https://img.shields.io/badge/header--only-yes-brightgreen.svg)](#installation)
 [![Lock-free](https://img.shields.io/badge/concurrency-lock--free-orange.svg)](#architecture)
-[![CI](https://github.com/SlickQuant/slick_queue/actions/workflows/ci.yml/badge.svg)](https://github.com/SlickQuant/slick_queue/actions/workflows/ci.yml)
-[![GitHub release](https://img.shields.io/github/v/release/SlickQuant/slick_queue)](https://github.com/SlickQuant/slick_queue/releases)
+[![CI](https://github.com/SlickQuant/slick-queue/actions/workflows/ci.yml/badge.svg)](https://github.com/SlickQuant/slick-queue/actions/workflows/ci.yml)
+[![GitHub release](https://img.shields.io/github/v/release/SlickQuant/slick-queue)](https://github.com/SlickQuant/slick-queue/releases)
 
 SlickQueue is a header-only C++ library that provides a lock-free,
 multi-producer multi-consumer (MPMC) queue built on a ring buffer. It is
@@ -45,25 +45,25 @@ vcpkg install slick-queue
 Then in your CMakeLists.txt:
 
 ```cmake
-find_package(slick_queue CONFIG REQUIRED)
-target_link_libraries(your_target PRIVATE slick_queue::slick_queue)
+find_package(slick-queue CONFIG REQUIRED)
+target_link_libraries(your_target PRIVATE slick::queue)
 ```
 
 ### Using CMake FetchContent
 
 ```cmake
 include(FetchContent)
 
-# Disable tests for slick_queue
+# Disable tests for slick-queue
 set(BUILD_SLICK_QUEUE_TESTS OFF CACHE BOOL "" FORCE)
 FetchContent_Declare(
-    slick_queue
-    GIT_REPOSITORY https://github.com/SlickQuant/slick_queue.git
-    GIT_TAG v1.1.0.0  # See https://github.com/SlickQuant/slick_queue/releases for latest version
+    slick-queue
+    GIT_REPOSITORY https://github.com/SlickQuant/slick-queue.git
+    GIT_TAG v1.1.0.0  # See https://github.com/SlickQuant/slick-queue/releases for latest version
 )
-FetchContent_MakeAvailable(slick_queue)
+FetchContent_MakeAvailable(slick-queue)
 
-target_link_libraries(your_target PRIVATE slick_queue)
+target_link_libraries(your_target PRIVATE slick::queue)
 ```
 
 ## Usage
diff --git a/cmake/slick-queueConfig.cmake.in b/cmake/slick-queueConfig.cmake.in
@@ -0,0 +1,5 @@
+@PACKAGE_INIT@
+
+include("${CMAKE_CURRENT_LIST_DIR}/slick-queueTargets.cmake")
+
+check_required_components(slick-queue)
diff --git a/cmake/slick_queueConfig.cmake.in b/cmake/slick_queueConfig.cmake.in
diff --git a/include/slick/queue.h b/include/slick/queue.h
@@ -5,7 +5,7 @@
  * This file is part of the SlickQueue. Redistribution and use in source and
  * binary forms, with or without modification, are permitted exclusively under
  * the terms of the MIT license which is available at
- * https://github.com/SlickQuant/slick_queue/blob/main/LICENSE
+ * https://github.com/SlickQuant/slick-queue/blob/main/LICENSE
  *
  ********************************************************************************/
 
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
@@ -12,9 +12,9 @@ if(NOT GTest_FOUND)
   FetchContent_MakeAvailable(googletest)
 endif()
 
-add_executable(slick_queue_tests tests.cpp shm_tests.cpp)
+add_executable(slick-queue-tests tests.cpp shm_tests.cpp)
 
-target_link_libraries(slick_queue_tests PRIVATE slick::slick_queue GTest::gtest_main)
+target_link_libraries(slick-queue-tests PRIVATE slick::queue GTest::gtest_main)
 
 include(GoogleTest)
-gtest_discover_tests(slick_queue_tests)
+gtest_discover_tests(slick-queue-tests)

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`* This file is part of the SlickQueue. Redistribution and use in source and`
`6`	`6`	`* binary forms, with or without modification, are permitted exclusively under`
`7`	`7`	`* the terms of the MIT license which is available at`
`8`		`- * https://github.com/SlickQuant/slick_queue/blob/main/LICENSE`
	`8`	`+ * https://github.com/SlickQuant/slick-queue/blob/main/LICENSE`
`9`	`9`	`*`
`10`	`10`	`********************************************************************************/`
`11`	`11`