From 4e79cc3284847e59fe16f4c3b4b0be351e3213ea Mon Sep 17 00:00:00 2001 From: Jenn Nguyen Date: Mon, 18 Jul 2022 10:20:24 -0700 Subject: [PATCH 1/8] Ignition -> Gazebo (#100) * Ignition -> Gazebo Signed-off-by: Jenn Nguyen * removed coverage badge Signed-off-by: Jenn Nguyen --- README.md | 41 ++++++++++++++++++++--------------------- 1 file changed, 20 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index f0dab8f..8e737cb 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,31 @@ -# Ignition tools: Ignition entry point for using all the suite of ignition tools +# Gazebo tools: Gazebo entry point for using all the suite of Gazebo tools **Maintainer:** caguero AT openrobotics DOT org -[![GitHub open issues](https://img.shields.io/github/issues-raw/ignitionrobotics/ign-tools.svg)](https://github.com/ignitionrobotics/ign-tools/issues) -[![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/ignitionrobotics/ign-tools.svg)](https://github.com/ignitionrobotics/ign-tools/pulls) +[![GitHub open issues](https://img.shields.io/github/issues-raw/gazebosim/gz-tools.svg)](https://github.com/gazebosim/gz-tools/issues) +[![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/gazebosim/gz-tools.svg)](https://github.com/gazebosim/gz-tools/pulls) [![Discourse topics](https://img.shields.io/discourse/https/community.gazebosim.org/topics.svg)](https://community.gazebosim.org) [![Hex.pm](https://img.shields.io/hexpm/l/plug.svg)](https://www.apache.org/licenses/LICENSE-2.0) Build | Status -- | -- -Test coverage | [![codecov](https://codecov.io/gh/ignitionrobotics/ign-tools/branch/ign-tools1/graph/badge.svg)](https://codecov.io/gh/ignitionrobotics/ign-tools) -Ubuntu Bionic | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_tools-ci-ign-tools1-bionic-amd64)](https://build.osrfoundation.org/job/ignition_tools-ci-ign-tools1-bionic-amd64) +Ubuntu Focal | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_tools-ci-ign-tools1-focal-amd64)](https://build.osrfoundation.org/job/ignition_tools-ci-ign-tools1-focal-amd64) Homebrew | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_tools-ci-ign-tools1-homebrew-amd64)](https://build.osrfoundation.org/job/ignition_tools-ci-ign-tools1-homebrew-amd64) Windows | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ign_tools-ign-1-win)](https://build.osrfoundation.org/job/ign_tools-ign-1-win) -Ignition tools provide the `ign` command line tool that accepts multiple +Gazebo tools provide the `ign` command line tool that accepts multiple subcommands. Each subcommand is implemented in a plugin that belongs to a -specific Ignition project. For example, all the commands that start with -`ign topic ...` will be implemented by the Ignition Transport library. +specific Gazebo project. For example, all the commands that start with +`ign topic ...` will be implemented by the Gazebo Transport library. -[http://ignitionrobotics.org](http://ignitionrobotics.org) +[http://gazebosim.org](http://gazebosim.org) **Note** While `ign-tools` is currently building on Windows 10, the command line utilities are not yet supported. # Installation -These instructions are for installing only Ignition Tools. -If you're interested in using all the Ignition libraries, check out this [Ignition installation](https://ignitionrobotics.org/docs/latest/install). +These instructions are for installing only Gazebo Tools. +If you're interested in using all the Gazebo libraries, check out this [Gazebo installation](https://gazebosim.org/docs/latest/install). We recommend following the Binary Installation instructions to get up and running as quickly and painlessly as possible. @@ -53,8 +52,8 @@ Miniconda suffices. Create if necessary, and activate a Conda environment: ``` -conda create -n ign-ws -conda activate ign-ws +conda create -n gz-ws +conda activate gz-ws ``` Install `ignition-tools`: @@ -71,7 +70,7 @@ which version you need, or leave it empty for version 1. ### Prerequisites -The following dependencies are required to compile ignition-tools from +The following dependencies are required to compile Gazebo tools from source: - cmake @@ -90,7 +89,7 @@ sudo make install ### Bash auto-completion -Source the [etc/ign.bash_completion.sh](etc/ign.bash_completion.sh) script in your bash terminal window to enable auto-complete: +Source the [etc/ign.bash_completion.sh](https://github.com/gazebosim/gz-tools/blob/ign-tools1/etc/ign.bash_completion.sh) script in your bash terminal window to enable auto-complete: ~~~ . etc/ign.bash_completion.sh ~~~ @@ -112,8 +111,8 @@ Miniconda suffices. Create if necessary, and activate a Conda environment: ``` -conda create -n ign-ws -conda activate ign-ws +conda create -n gz-ws +conda activate gz-ws ``` Install prerequisites: @@ -140,17 +139,17 @@ This assumes you have created and activated a Conda environment while installing # Contributing -Please see the [contribution guide](https://ignitionrobotics.org/docs/all/contributing). +Please see the [contribution guide](https://gazebosim.org/docs/all/contributing). # Code of Conduct Please see -[CODE_OF_CONDUCT.md](https://github.com/ignitionrobotics/ign-gazebo/blob/main/CODE_OF_CONDUCT.md). +[CODE_OF_CONDUCT.md](https://github.com/gazebosim/gz-sim/blob/main/CODE_OF_CONDUCT.md). # Versioning -This library uses [Semantic Versioning](https://semver.org/). Additionally, this library is part of the [Ignition Robotics project](https://ignitionrobotics.org) which periodically releases a versioned set of compatible and complimentary libraries. See the [Ignition Robotics website](https://ignitionrobotics.org) for version and release information. +This library uses [Semantic Versioning](https://semver.org/). Additionally, this library is part of the [Gazebo project](https://gazebosim.org) which periodically releases a versioned set of compatible and complimentary libraries. See the [Gazebo website](https://gazebosim.org) for version and release information. # License -This library is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0). See also the [LICENSE](https://github.com/ignitionrobotics/ign-gazebo/blob/main/LICENSE) file. +This library is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0). See also the [LICENSE](https://github.com/gazebosim/gz-sim/blob/main/LICENSE) file. From 62c11f4ea4ea8ca31ee861ac4345e558522996a4 Mon Sep 17 00:00:00 2001 From: "Addisu Z. Taddese" Date: Thu, 11 Aug 2022 12:10:59 -0500 Subject: [PATCH 2/8] Source bash completion files for all other gz libraries (#104) Also Install to bash-completion Signed-off-by: Addisu Z. Taddese --- etc/CMakeLists.txt | 3 ++- etc/ign.bash_completion.sh | 3 +++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/etc/CMakeLists.txt b/etc/CMakeLists.txt index 3a321e0..6cc3b41 100644 --- a/etc/CMakeLists.txt +++ b/etc/CMakeLists.txt @@ -14,5 +14,6 @@ configure_file( "${CMAKE_CURRENT_BINARY_DIR}/ign${PROJECT_MAJOR_VERSION}.bash_completion.sh" @ONLY) install(FILES ${CMAKE_CURRENT_BINARY_DIR}/ign${PROJECT_MAJOR_VERSION}.bash_completion.sh + RENAME ign DESTINATION - ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_DATAROOTDIR}/gz/gz${PROJECT_MAJOR_VERSION}.completion.d) + ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_DATAROOTDIR}/bash-completion/completions) diff --git a/etc/ign.bash_completion.sh b/etc/ign.bash_completion.sh index 0b70ee2..3b11de7 100644 --- a/etc/ign.bash_completion.sh +++ b/etc/ign.bash_completion.sh @@ -67,4 +67,7 @@ function _ign COMPREPLY=($(compgen -W "${opts}" -- ${cur})) } + +source @CMAKE_INSTALL_PREFIX@/@CMAKE_INSTALL_DATAROOTDIR@/gz/gz@PROJECT_MAJOR_VERSION@.completion + complete -F "_ign" "ign" From 6fdaba500fa51e8db4b913725b7f53c9bc87c5ef Mon Sep 17 00:00:00 2001 From: "Addisu Z. Taddese" Date: Fri, 12 Aug 2022 17:28:24 -0500 Subject: [PATCH 3/8] Handle the case where there are no libraries installed (#106) Signed-off-by: Addisu Z. Taddese --- etc/gz.completion | 1 + etc/ign.bash_completion.sh | 5 +++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/etc/gz.completion b/etc/gz.completion index 8c8d716..3dcc4db 100644 --- a/etc/gz.completion +++ b/etc/gz.completion @@ -25,5 +25,6 @@ SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )" # version numbers, which means functions from newer versions will overwrite # those from older versions. for f in $SCRIPT_DIR/gz*.completion.d/*.bash_completion.sh ; do + [[ -e "$f" ]] || continue source $f done diff --git a/etc/ign.bash_completion.sh b/etc/ign.bash_completion.sh index 3b11de7..dce5234 100644 --- a/etc/ign.bash_completion.sh +++ b/etc/ign.bash_completion.sh @@ -43,7 +43,7 @@ function _ign # Subcommand is help if [[ "$cmd" == "help" ]]; then - opts=$(ign --commands) + opts=$(ign --commands) || opts="" # Subcommand is a library name or an option (-*) else @@ -62,7 +62,8 @@ function _ign # on first word, top-level command (ign) else - opts="$(ign --commands) help" + commands=$(ign --commands) || commands="" + opts="${commands} help" fi COMPREPLY=($(compgen -W "${opts}" -- ${cur})) From 67d9d473aca6d33fb849e93e309cd678a75ccd71 Mon Sep 17 00:00:00 2001 From: Louise Poubel Date: Fri, 12 Aug 2022 16:30:10 -0700 Subject: [PATCH 4/8] =?UTF-8?q?=F0=9F=8E=88=201.5.0=20(#107)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Louise Poubel --- CMakeLists.txt | 4 ++-- Changelog.md | 28 +++++++++++++++++++++++++++- 2 files changed, 29 insertions(+), 3 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 7fcecb8..07164a3 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -15,8 +15,8 @@ string (TOLOWER ${PROJECT_NAME} PROJECT_NAME_LOWER) string (TOUPPER ${PROJECT_NAME} PROJECT_NAME_UPPER) set (PROJECT_MAJOR_VERSION 1) -set (PROJECT_MINOR_VERSION 4) -set (PROJECT_PATCH_VERSION 1) +set (PROJECT_MINOR_VERSION 5) +set (PROJECT_PATCH_VERSION 0) set (PROJECT_VERSION ${PROJECT_MAJOR_VERSION}.${PROJECT_MINOR_VERSION}) set (PROJECT_VERSION_FULL ${PROJECT_MAJOR_VERSION}.${PROJECT_MINOR_VERSION}.${PROJECT_PATCH_VERSION}) diff --git a/Changelog.md b/Changelog.md index 8c33ecb..f485845 100644 --- a/Changelog.md +++ b/Changelog.md @@ -1,4 +1,30 @@ -# Ignition Tools 1.x +# Gazebo Tools 1.x + +### Gazebo Tools 1.5.0 (2022-08-12) + +1. Bash completion for subcommand names and flags + * [Pull request #77](https://github.com/gazebosim/gz-tools/pull/77) + * [Pull request #86](https://github.com/gazebosim/gz-tools/pull/86) + * [Pull request #87](https://github.com/gazebosim/gz-tools/pull/87) + * [Pull request #104](https://github.com/gazebosim/gz-tools/pull/104) + * [Pull request #106](https://github.com/gazebosim/gz-tools/pull/106) + +1. Infrastructure & CI + * [Pull request #100](https://github.com/gazebosim/gz-tools/pull/100) + * [Pull request #80](https://github.com/gazebosim/gz-tools/pull/80) + * [Pull request #75](https://github.com/gazebosim/gz-tools/pull/75) + +1. Remove unused config.hh.in + * [Pull request #91](https://github.com/gazebosim/gz-tools/pull/91) + +1. Bump CMake to 2.8.12 + * [Pull request #85](https://github.com/gazebosim/gz-tools/pull/85) + +1. Fix `.dll` installation directory on Windows + * [Pull request #74](https://github.com/gazebosim/gz-tools/pull/74) + +1. Permit to invoke `ign` command in Windows + * [Pull request #73](https://github.com/gazebosim/gz-tools/pull/73) ### Ignition Tools 1.4.1 (2021-10-27) From 6eca3cdbe431fd98a1c0f20ba0016b86777e004f Mon Sep 17 00:00:00 2001 From: Louise Poubel Date: Tue, 30 Aug 2022 10:45:01 -0700 Subject: [PATCH 5/8] Remove ign CLI from version 2 (#109) Signed-off-by: Louise Poubel --- Migration.md | 2 +- src/CMakeLists.txt | 12 ++---------- 2 files changed, 3 insertions(+), 11 deletions(-) diff --git a/Migration.md b/Migration.md index ac42124..ae59219 100644 --- a/Migration.md +++ b/Migration.md @@ -9,7 +9,7 @@ release will remove the deprecated code. * This package now depends on gz-cmake * The environment variable `IGN_CONFIG_PATH` is deprecated. Use `GZ_CONFIG_PATH` instead. -* The `ign` command line executable is deprecated. Use `gz` instead. +* The `ign` command line executable is removed. Use `gz` instead. * The project name has been changed to use the `gz-` prefix, you **must** use the `gz` prefix! * This also means that any generated code that use the project name (e.g. CMake variables, in-source macros) would have to be migrated. diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index ce5fa1e..a80a014 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -64,18 +64,10 @@ if(WIN32) # On Windows also install the gz.bat wrapper script to permit to # invoke gz via Command Prompt or Powershell install(PROGRAMS gz.bat DESTINATION ${GZ_BIN_INSTALL_DIR}) - - # TODO(chapulina) tick-tock ign on Windows if someone actually needs it. It's - # complicated to symlink / copy files on Windows. -else() - # TODO(CH3): Deprecated. Tick-tock the ign executable with symlink - # This is exceptionally scuffed - install(CODE "execute_process(COMMAND ${CMAKE_COMMAND} -E create_symlink - ${CMAKE_INSTALL_PREFIX}/${GZ_BIN_INSTALL_DIR}/gz - ${PROJECT_BINARY_DIR}/ign)") - install(PROGRAMS ${PROJECT_BINARY_DIR}/ign DESTINATION ${GZ_BIN_INSTALL_DIR}) endif() +# Note: The `ign` CLI isn't installed on purpose so that v2 is co-installable with v1 + #=============================================================================== # BEGIN TEST gz command # Generate the ruby script for internal testing. From a222682118fad5bd9c64699c30e3c775bb02de79 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20Ag=C3=BCero?= Date: Thu, 22 Sep 2022 19:35:26 +0200 Subject: [PATCH 6/8] 2.0.0 changelog. (#112) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Carlos Agüero Signed-off-by: Carlos Agüero --- Changelog.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/Changelog.md b/Changelog.md index 0471424..41acd79 100644 --- a/Changelog.md +++ b/Changelog.md @@ -2,7 +2,40 @@ ### Gazebo Tools 2.X.X (20XX-XX-XX) -### Gazebo Tools 2.0.0 (20XX-XX-XX) +### Gazebo Tools 2.0.0 (2022-09-22) + +1. Remove ign CLI from version 2 + * [Pull request #109](https://github.com/gazebosim/gz-tools/pull/109) + +1. Finale: CMake var followups, docs, and paths + * [Pull request #99](https://github.com/gazebosim/gz-tools/pull/99) + +1. ign -> gz Partial Docs Migration and Project Name Followups : gz-tools + * [Pull request #98](https://github.com/gazebosim/gz-tools/pull/98) + +1. Rename CMake project to gz + * [Pull request #93](https://github.com/gazebosim/gz-tools/pull/93) + +1. Use gz-cmake + * [Pull request #96](https://github.com/gazebosim/gz-tools/pull/96) + +1. ign -> gz CLI Migration : gz-tools + * [Pull request #94](https://github.com/gazebosim/gz-tools/pull/94) + +1. Standardize config macros + * [Pull request #90](https://github.com/gazebosim/gz-tools/pull/90) + +1. Migrate ignition:: to gz:: + * [Pull request #89](https://github.com/gazebosim/gz-tools/pull/89) + +1. Remove Bionic from future releases (Garden+) + * [Pull request #78](https://github.com/gazebosim/gz-tools/pull/78) + +1. Update codeowners + * [Pull request #27](https://github.com/gazebosim/gz-tools/pull/27) + +1. [master] Workflow updates + * [Pull request #18](https://github.com/gazebosim/gz-tools/pull/18) ## Gazebo Tools 1.x From 30378e3ed34b4db58a6afa0ddfc2cb7140a1eda1 Mon Sep 17 00:00:00 2001 From: Nate Koenig Date: Thu, 22 Sep 2022 11:35:38 -0700 Subject: [PATCH 7/8] 2.0.0 release Signed-off-by: Nate Koenig --- CMakeLists.txt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index b59867b..95facaa 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -14,8 +14,7 @@ set(GZ_CMAKE_VER ${gz-cmake3_VERSION_MAJOR}) #============================================================================ # Configure the project #============================================================================ -gz_configure_project( - VERSION_SUFFIX pre1) +gz_configure_project(VERSION_SUFFIX) #============================================================================ # Set project-specific options From 6dca228d040dd3ab512407ce4c40ee1a94a67dbc Mon Sep 17 00:00:00 2001 From: Nate Koenig Date: Wed, 16 Nov 2022 10:49:29 -0800 Subject: [PATCH 8/8] Update doc Signed-off-by: Nate Koenig --- src/CMakeLists.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index a80a014..a20e3eb 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -66,7 +66,7 @@ if(WIN32) install(PROGRAMS gz.bat DESTINATION ${GZ_BIN_INSTALL_DIR}) endif() -# Note: The `ign` CLI isn't installed on purpose so that v2 is co-installable with v1 +# Note: The `ign` CLI isn't installed on purpose so that v3 is co-installable with v2 #=============================================================================== # BEGIN TEST gz command