From 22868e8b4d853814fd07d2a301219558e60be580 Mon Sep 17 00:00:00 2001 From: boxanm Date: Tue, 7 May 2024 08:38:42 -0400 Subject: [PATCH 01/19] Read libnabo version from package.xml, instead of the header of nabo.h --- CMakeLists.txt | 16 +++++++++++----- nabo/nabo.h | 8 +------- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 7ba5fb7..d3bcdd4 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -11,11 +11,17 @@ project("lib${LIB_NAME}") set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}) -# Extract version from header -file(READ "nabo/nabo.h" NABO_HEADER_CONTENT) -string(REGEX MATCH "#define NABO_VERSION \"([0-9]+\.[0-9]+\.[0-9]+)\"" _ ${NABO_HEADER_CONTENT}) -set(PROJECT_VERSION ${CMAKE_MATCH_1}) -message(STATUS ${PROJECT_VERSION}) +## Extract version from package.xml +file(READ "package.xml" PACKAGE_XML_CONTENT) +string(REGEX MATCH "([^<]+)" VERSION_MATCH ${PACKAGE_XML_CONTENT}) +# Extract the matched version from the captured group +if(VERSION_MATCH) + # CMake variable ${CMAKE_MATCH_1} contains the matched version + set(PROJECT_VERSION ${CMAKE_MATCH_1}) + message(STATUS "Found package version: ${PROJECT_VERSION}") +else() + message(WARNING "Package version not found in package.xml") +endif() if (NOT CMAKE_BUILD_TYPE) message("-- No build type specified; defaulting to CMAKE_BUILD_TYPE=Release.") diff --git a/nabo/nabo.h b/nabo/nabo.h index 6f8a699..addb4a9 100644 --- a/nabo/nabo.h +++ b/nabo/nabo.h @@ -204,13 +204,7 @@ libnabo differs from \ref ANN on the following points: //! Namespace for Nabo namespace Nabo { - //! \defgroup public public interface - //@{ - - //! version of the Nabo library as string - #define NABO_VERSION "1.0.7" - //! version of the Nabo library as an int - #define NABO_VERSION_INT 10007 + //! \defgroup public public interface // TODO (c++14) Convert invalidIndex, invalidValue to constexpr templated variables. template From 94151aa31dc065ea2d281e6cc50c8ffeb6f7e789 Mon Sep 17 00:00:00 2001 From: boxanm Date: Tue, 7 May 2024 09:05:03 -0400 Subject: [PATCH 02/19] Add github action to update libnabo's documentation --- .github/workflows/update_documentation.yaml | 33 +++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 .github/workflows/update_documentation.yaml diff --git a/.github/workflows/update_documentation.yaml b/.github/workflows/update_documentation.yaml new file mode 100644 index 0000000..9e60d5f --- /dev/null +++ b/.github/workflows/update_documentation.yaml @@ -0,0 +1,33 @@ +name: Generate and Deploy Doxygen Documentation + +on: + push: + branches: + - main # Modify this to match your main branch name + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Checkout Repository + uses: actions/checkout@v2 + + - name: Install Dependencies + run: | + sudo apt-get update + sudo apt-get install -y build-essential cmake doxygen graphviz libboost-all-dev libeigen3-dev + + - name: Configure and Build Project + run: | + mkdir build + cd build + cmake .. + make doc + + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./build/doc/html # Directory containing the HTML documentation + From e54e7e32da44bfccc2486c44f36434e5a8704d4a Mon Sep 17 00:00:00 2001 From: boxanm <47394922+boxanm@users.noreply.github.com> Date: Tue, 7 May 2024 09:08:49 -0400 Subject: [PATCH 03/19] Allow manual trigerring of update_documentation.yaml --- .github/workflows/update_documentation.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/update_documentation.yaml b/.github/workflows/update_documentation.yaml index 9e60d5f..1c96893 100644 --- a/.github/workflows/update_documentation.yaml +++ b/.github/workflows/update_documentation.yaml @@ -4,6 +4,8 @@ on: push: branches: - main # Modify this to match your main branch name + + workflow_dispatch: # Allow manual triggering jobs: build: From e71f61a2c9f917410c5b5026d632b5e7c0df816a Mon Sep 17 00:00:00 2001 From: boxanm Date: Tue, 7 May 2024 09:18:22 -0400 Subject: [PATCH 04/19] Update workflow branches --- .github/workflows/update_documentation.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/update_documentation.yaml b/.github/workflows/update_documentation.yaml index 1c96893..1b7afe2 100644 --- a/.github/workflows/update_documentation.yaml +++ b/.github/workflows/update_documentation.yaml @@ -3,7 +3,8 @@ name: Generate and Deploy Doxygen Documentation on: push: branches: - - main # Modify this to match your main branch name + - master + - github-action-api-docs # Modify this to match your master branch name workflow_dispatch: # Allow manual triggering From 91d16d0c254374e0347ad8cd9d1bbc55d520c36c Mon Sep 17 00:00:00 2001 From: boxanm Date: Tue, 7 May 2024 09:45:57 -0400 Subject: [PATCH 05/19] Deploy documentation page from a release folder --- .github/workflows/update_documentation.yaml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.github/workflows/update_documentation.yaml b/.github/workflows/update_documentation.yaml index 1b7afe2..6fa8dee 100644 --- a/.github/workflows/update_documentation.yaml +++ b/.github/workflows/update_documentation.yaml @@ -8,6 +8,10 @@ on: workflow_dispatch: # Allow manual triggering + release: + types: + - published + jobs: build: runs-on: ubuntu-latest @@ -33,4 +37,9 @@ jobs: with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./build/doc/html # Directory containing the HTML documentation + if: ${{ github.event.release.tag_name }} + destination_dir: ./releases/${{ github.event.release.tag_name }} + keep_files: false + commit_message: Release ${{ github.event.release.tag_name }} + From 1b60e68e625882970958d897e4c849e31ca8b29b Mon Sep 17 00:00:00 2001 From: boxanm Date: Tue, 7 May 2024 10:43:52 -0400 Subject: [PATCH 06/19] Update documentation workflow --- .github/workflows/update_documentation.yaml | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/.github/workflows/update_documentation.yaml b/.github/workflows/update_documentation.yaml index 6fa8dee..7ac4683 100644 --- a/.github/workflows/update_documentation.yaml +++ b/.github/workflows/update_documentation.yaml @@ -33,13 +33,7 @@ jobs: make doc - name: Deploy to GitHub Pages - uses: peaceiris/actions-gh-pages@v3 + uses: JamesIves/github-pages-deploy-action@v4 with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./build/doc/html # Directory containing the HTML documentation - if: ${{ github.event.release.tag_name }} - destination_dir: ./releases/${{ github.event.release.tag_name }} - keep_files: false - commit_message: Release ${{ github.event.release.tag_name }} - - + folder: ./build/doc + branch: gh-pages From 4ed593ba9e9d89279ed73b5f94f4cae1987837ad Mon Sep 17 00:00:00 2001 From: boxanm <47394922+boxanm@users.noreply.github.com> Date: Tue, 7 May 2024 11:07:37 -0400 Subject: [PATCH 07/19] Update update_documentation.yaml --- .github/workflows/update_documentation.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/update_documentation.yaml b/.github/workflows/update_documentation.yaml index 7ac4683..bac9731 100644 --- a/.github/workflows/update_documentation.yaml +++ b/.github/workflows/update_documentation.yaml @@ -13,7 +13,7 @@ on: - published jobs: - build: + build-and-deploy: runs-on: ubuntu-latest steps: From 04ad8e02367c1b0c599f1fd65df647b14ad22a65 Mon Sep 17 00:00:00 2001 From: boxanm Date: Tue, 7 May 2024 11:27:18 -0400 Subject: [PATCH 08/19] Update documentation workflow --- .github/workflows/update_documentation.yaml | 27 +++++++++++++++++---- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/.github/workflows/update_documentation.yaml b/.github/workflows/update_documentation.yaml index bac9731..935d3e6 100644 --- a/.github/workflows/update_documentation.yaml +++ b/.github/workflows/update_documentation.yaml @@ -13,7 +13,7 @@ on: - published jobs: - build-and-deploy: + build: runs-on: ubuntu-latest steps: @@ -32,8 +32,25 @@ jobs: cmake .. make doc - - name: Deploy to GitHub Pages - uses: JamesIves/github-pages-deploy-action@v4 + - name: Setup Pages + id: pages + uses: actions/configure-pages@v3 + - name: Build with Jekyll + uses: actions/jekyll-build-pages@v1 with: - folder: ./build/doc - branch: gh-pages + source: ./build/doc + destination: ./_site + - name: Upload artifact + uses: actions/upload-pages-artifact@v2 + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{steps.deployment.outputs.page_url}} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2 \ No newline at end of file From 392969aafede06faced5c69527d70631da65910f Mon Sep 17 00:00:00 2001 From: boxanm Date: Tue, 7 May 2024 11:30:18 -0400 Subject: [PATCH 09/19] Add missing permissions --- .github/workflows/update_documentation.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/update_documentation.yaml b/.github/workflows/update_documentation.yaml index 935d3e6..4a5b78c 100644 --- a/.github/workflows/update_documentation.yaml +++ b/.github/workflows/update_documentation.yaml @@ -48,6 +48,10 @@ jobs: environment: name: github-pages url: ${{steps.deployment.outputs.page_url}} + permissions: + pages: write # to deploy to Pages + id-token: write # to verify the deployment originates from an appropriate source + runs-on: ubuntu-latest needs: build steps: From 5a0a7195c2858c2e47e978201cd9b6e792c55f3d Mon Sep 17 00:00:00 2001 From: boxanm Date: Tue, 7 May 2024 11:35:20 -0400 Subject: [PATCH 10/19] Fix documentation path --- .github/workflows/update_documentation.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/update_documentation.yaml b/.github/workflows/update_documentation.yaml index 4a5b78c..ea9f07d 100644 --- a/.github/workflows/update_documentation.yaml +++ b/.github/workflows/update_documentation.yaml @@ -38,7 +38,7 @@ jobs: - name: Build with Jekyll uses: actions/jekyll-build-pages@v1 with: - source: ./build/doc + source: ./build/doc/html destination: ./_site - name: Upload artifact uses: actions/upload-pages-artifact@v2 From 30105844fb63808fafd062e6c7082bb6de052062 Mon Sep 17 00:00:00 2001 From: boxanm Date: Tue, 7 May 2024 11:39:02 -0400 Subject: [PATCH 11/19] Remove temporary action triggers --- .github/workflows/update_documentation.yaml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/.github/workflows/update_documentation.yaml b/.github/workflows/update_documentation.yaml index ea9f07d..2ab25dc 100644 --- a/.github/workflows/update_documentation.yaml +++ b/.github/workflows/update_documentation.yaml @@ -4,14 +4,9 @@ on: push: branches: - master - - github-action-api-docs # Modify this to match your master branch name workflow_dispatch: # Allow manual triggering - release: - types: - - published - jobs: build: runs-on: ubuntu-latest From ddb5c3bc9c776aee0f788972c70d58f9279f068a Mon Sep 17 00:00:00 2001 From: boxanm Date: Tue, 7 May 2024 11:42:13 -0400 Subject: [PATCH 12/19] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 91ab9b1..a6b2647 100644 --- a/README.md +++ b/README.md @@ -158,10 +158,10 @@ libnabo provides the following compilation options, available through [CMake]: ### Documentation -You can generate the documentation by typing: - - make doc - +You can access on https://norlab-ulaval.github.io/libnabo/. Alternatively, you can generate it locally by typing: +```bash +make doc +``` Prerequisites ------------- From 6b005847ca996153abca6c39c0e68b35b70bde4b Mon Sep 17 00:00:00 2001 From: boxanm Date: Sat, 18 May 2024 13:17:09 -0400 Subject: [PATCH 13/19] Update NABO_VERSION --- nabo/nabo.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/nabo/nabo.h b/nabo/nabo.h index addb4a9..9d6963b 100644 --- a/nabo/nabo.h +++ b/nabo/nabo.h @@ -205,6 +205,12 @@ libnabo differs from \ref ANN on the following points: namespace Nabo { //! \defgroup public public interface + //@{ + + //! version of the Nabo library as string + #define NABO_VERSION "1.1.1" + //! version of the Nabo library as an int + #define NABO_VERSION_INT 10101 // TODO (c++14) Convert invalidIndex, invalidValue to constexpr templated variables. template From f9c1f11c68da67dddc1c2c0af637e30b6ff946e8 Mon Sep 17 00:00:00 2001 From: boxanm Date: Sat, 18 May 2024 13:17:33 -0400 Subject: [PATCH 14/19] Throw error when version number in package.xml is not filled --- CMakeLists.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index d3bcdd4..a5f0c44 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -20,7 +20,7 @@ if(VERSION_MATCH) set(PROJECT_VERSION ${CMAKE_MATCH_1}) message(STATUS "Found package version: ${PROJECT_VERSION}") else() - message(WARNING "Package version not found in package.xml") + message(SEND_ERROR "Package version not found in package.xml") endif() if (NOT CMAKE_BUILD_TYPE) From 9b5b6ba8569937590dbc89e2d8df05105305f301 Mon Sep 17 00:00:00 2001 From: boxanm Date: Thu, 23 May 2024 11:56:15 -0400 Subject: [PATCH 15/19] Update CHANGELOG.rst --- CHANGELOG.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 7e977b3..d75592c 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,6 +2,18 @@ Changelog for package libnabo ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Forthcoming +----------- +* Merge pull request `#137 `_ from norlab-ulaval/github-action-api-docs + Add a GitHub action to upload API documentation to a webpage +* CMake read libnabo version from package.xml, instead of the header of nabo.h +* Merge pull request `#136 `_ from norlab-ulaval/release + Mod docker compose services for running with docker-container driver +* ci: update submodule to latest and mod service for docker-container driver +* ci: force norlab-teamcity-server release build configuration + [skip release] +* Contributors: Luc Coupal, RedLeaderOne, boxanm + 1.1.1 (2024-03-19) ------------------ From 59ab560d98d20ad9cf70936ba73e6034ca374585 Mon Sep 17 00:00:00 2001 From: boxanm Date: Thu, 23 May 2024 11:58:11 -0400 Subject: [PATCH 16/19] Bump version number to 1.1.2 in libnabo_installer.bash and nabo.h --- libnabo_installer.bash | 2 +- nabo/nabo.h | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/libnabo_installer.bash b/libnabo_installer.bash index dfa4728..091777f 100644 --- a/libnabo_installer.bash +++ b/libnabo_installer.bash @@ -9,7 +9,7 @@ # Arguments: # --install-path The directory where to install libnabo (absolute path) # (default location defined in the .env) -# --repository-version 1.0.7 Install libnabo release tag version (default to master branch latest) +# --repository-version 1.1.2 Install libnabo release tag version (default to master branch latest) # --compile-test Compile the libnabo unit-test # --generate-doc Generate the libnabo doxygen documentation # in /usr/local/share/doc/libnabo/api/html/index.html diff --git a/nabo/nabo.h b/nabo/nabo.h index 9d6963b..daa1276 100644 --- a/nabo/nabo.h +++ b/nabo/nabo.h @@ -208,9 +208,9 @@ namespace Nabo //@{ //! version of the Nabo library as string - #define NABO_VERSION "1.1.1" + #define NABO_VERSION "1.1.2" //! version of the Nabo library as an int - #define NABO_VERSION_INT 10101 + #define NABO_VERSION_INT 10102 // TODO (c++14) Convert invalidIndex, invalidValue to constexpr templated variables. template From 27efea67a7b9f24b84c6f5126c611cc882f4a0fb Mon Sep 17 00:00:00 2001 From: boxanm Date: Thu, 23 May 2024 11:59:05 -0400 Subject: [PATCH 17/19] Update .gitignore --- .gitignore | 347 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 347 insertions(+) diff --git a/.gitignore b/.gitignore index bdc5af0..646bf39 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,349 @@ +*.cproject +*.project *~ +*.swp +*.cur_trans build + +# ============================================================================ +# Created by https://www.toptal.com/developers/gitignore/api/visualstudiocode,clion,c++,python +# Edit at https://www.toptal.com/developers/gitignore?templates=visualstudiocode,clion,c++,python + +### C++ ### +# Prerequisites +*.d + +# Compiled Object files +*.slo +*.lo +*.o +*.obj + +# Precompiled Headers +*.gch +*.pch + +# Compiled Dynamic libraries +*.so +*.dylib +*.dll + +# Fortran module files +*.mod +*.smod + +# Compiled Static libraries +*.lai +*.la +*.a +*.lib + +# Executables +*.exe +*.out +*.app + +### CLion ### +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# User-specific stuff +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# AWS User-specific +.idea/**/aws.xml + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml +.idea/**/libraries + +# Gradle and Maven with auto-import +# When using Gradle or Maven with auto-import, you should exclude module files, +# since they will be recreated, and may cause churn. Uncomment if using +# auto-import. +# .idea/artifacts +# .idea/compiler.xml +# .idea/jarRepositories.xml +# .idea/modules.xml +# .idea/*.iml +# .idea/modules +# *.iml +# *.ipr + +# CMake +cmake-build-*/ + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# File-based project format +*.iws + +# IntelliJ +out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# SonarLint plugin +.idea/sonarlint/ + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +# Editor-based Rest Client +.idea/httpRequests + +# Android studio 3.1+ serialized cache file +.idea/caches/build_file_checksums.ser + +### CLion Patch ### +# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721 + +# *.iml +# modules.xml +# .idea/misc.xml +# *.ipr + +# Sonarlint plugin +# https://plugins.jetbrains.com/plugin/7973-sonarlint +.idea/**/sonarlint/ + +# SonarQube Plugin +# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin +.idea/**/sonarIssues.xml + +# Markdown Navigator plugin +# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced +.idea/**/markdown-navigator.xml +.idea/**/markdown-navigator-enh.xml +.idea/**/markdown-navigator/ + +# Cache file creation bug +# See https://youtrack.jetbrains.com/issue/JBR-2257 +.idea/$CACHE_FILE$ + +# CodeStream plugin +# https://plugins.jetbrains.com/plugin/12206-codestream +.idea/codestream.xml + +# Azure Toolkit for IntelliJ plugin +# https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij +.idea/**/azureSettings.xml + +### Python ### +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + +### Python Patch ### +# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration +poetry.toml + +# ruff +.ruff_cache/ + +# LSP config files +pyrightconfig.json + +### VisualStudioCode ### +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +!.vscode/*.code-snippets + +# Local History for Visual Studio Code +.history/ + +# Built Visual Studio Code Extensions +*.vsix + +### VisualStudioCode Patch ### +# Ignore all local history of files +.history +.ionide + +# End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,clion,c++,python From c57551f712ee2471fa816baebba120f320f73b44 Mon Sep 17 00:00:00 2001 From: boxanm Date: Thu, 23 May 2024 11:59:57 -0400 Subject: [PATCH 18/19] 1.1.2 --- CHANGELOG.rst | 4 ++-- package.xml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index d75592c..7fa215c 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,8 +2,8 @@ Changelog for package libnabo ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Forthcoming ------------ +1.1.2 (2024-05-23) +------------------ * Merge pull request `#137 `_ from norlab-ulaval/github-action-api-docs Add a GitHub action to upload API documentation to a webpage * CMake read libnabo version from package.xml, instead of the header of nabo.h diff --git a/package.xml b/package.xml index e89c11e..d478580 100644 --- a/package.xml +++ b/package.xml @@ -1,7 +1,7 @@ libnabo - 1.1.1 + 1.1.2 libnabo is a fast K Nearest Neighbour library for low-dimensional spaces. From ff86d860a2fa068c236581cc84d0344028b9a9d0 Mon Sep 17 00:00:00 2001 From: boxanm <47394922+boxanm@users.noreply.github.com> Date: Mon, 27 May 2024 09:45:23 -0400 Subject: [PATCH 19/19] Remove .env from .gitignore --- .gitignore | 2 -- 1 file changed, 2 deletions(-) diff --git a/.gitignore b/.gitignore index 646bf39..6a46063 100644 --- a/.gitignore +++ b/.gitignore @@ -278,9 +278,7 @@ celerybeat.pid *.sage.py # Environments -.env .venv -env/ venv/ ENV/ env.bak/