Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename everything to gz_ekumen_worlds #4

Merged
merged 1 commit into from
Feb 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@ jobs:
required-ros-distributions: jazzy
- uses: ros-tooling/action-ros-ci@v0.3
with:
package-name: gz-ekumen
package-name: gz_ekumen_worlds
target-ros2-distro: jazzy
import-token: ${{ secrets.GITHUB_TOKEN }}
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

The contributing guidelines are based on the [Andino](https://github.com/Ekumen-OS/andino) project's guidelines.

## Contributing to `gz-worlds`
## Contributing to `gz_ekumen_worlds`

The following is a set of guidelines for contributing to the `gz-worlds` project.
The following is a set of guidelines for contributing to the `gz_ekumen_worlds` project.
These are mostly guidelines, not rules. Use your best judgment, and feel free to
propose changes to this document in a pull request.

Expand Down Expand Up @@ -49,12 +49,12 @@ Provide more context by answering these questions:

Include details about your configuration and environment:

* **Which version of `gz-worlds` are you using?**?
* **Which version of `gz_ekumen_worlds` are you using?**?
* **What's the name and version of the OS you're using**?
* **What's the ROS 2 distribution you're using**?
* **What's the Gazebo version you're using**?
* **Are you running `gz-worlds` using the provided docker container?** See [docker](docker/README.md).
* **Are you running `gz-worlds` in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and the guest?
* **Are you running `gz_ekumen_worlds` using the provided docker container?** See [docker](docker/README.md).
* **Are you running `gz_ekumen_worlds` in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and the guest?


### Suggesting Enhancements
Expand All @@ -75,7 +75,7 @@ existed.

* **Check if you're using the latest software version**. A more recent version may contain your desired feature.
* **Determine which repository the enhancement should be suggested in**
* **Perform a** [cursory search](https://github.com/Ekumen-OS/gz-worlds/issues?q=is%3Aissue) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
* **Perform a** [cursory search](https://github.com/Ekumen-OS/gz_ekumen_worlds/issues?q=is%3Aissue) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.

#### How Do I Submit A (Good) Enhancement Suggestion

Expand All @@ -89,7 +89,7 @@ After you've determined which repository your enhancement suggestion is related
* **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
* **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem.
* **Explain why this enhancement would be useful** to most users and isn't something that can or should be implemented as a separate application.
* **Specify which version of `gz-worlds` you're using.**
* **Specify which version of `gz_ekumen_worlds` you're using.**
* **Specify the name and version of the OS you're using.**

### Contributing Code
Expand All @@ -100,7 +100,7 @@ get acquainted with this development process.

#. **Read the** [reporting_bugs](#reporting-bugs) **and** [suggesting_enhancements](#suggesting-enhancements) **sections first.**

#. **Fork the `gz-worlds` repository**. All of your development should take place in your fork.
#. **Fork the `gz_ekumen_worlds` repository**. All of your development should take place in your fork.
- An important thing to do is create a remote pointing to the [upstream remote repository](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork). This way, you can always check for modifications on the original repository and **always** keep your fork repository up to date.

#. **Work out of a new branch**, one that is not
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ These worlds have been tested the following matrix:
Once built and sourced, package resources may be found under `<package-name>/models` and `<package-name>/worlds`, e.g.:

``` sh
gz sim -r gz-ekumen/worlds/populated_ekumen_hq4.world # for Gazebo Garden and later versions
ign gazebo -r gz-ekumen/worlds/populated_ekumen_hq4.world # for Gazebo Fortress and earlier versions
gz sim -r gz_ekumen_worlds/worlds/populated_ekumen_hq4.world # for Gazebo Garden and later versions
ign gazebo -r gz_ekumen_worlds/worlds/populated_ekumen_hq4.world # for Gazebo Fortress and earlier versions
```

## :raised_hands: Contributing
Expand Down
10 changes: 5 additions & 5 deletions docker/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
services:
gz-worlds-dev:
gz_ekumen_worlds-dev:
build:
context: ..
dockerfile: docker/images/${ROSDISTRO:-humble}/Dockerfile
args:
- GZ_VERSION=${GZ_VERSION:-harmonic}
image: ekumenlabs/gz-worlds-${ROSDISTRO:-humble}-dev
hostname: gz-worlds-${ROSDISTRO:-humble}-dev
container_name: gz-worlds-${ROSDISTRO:-humble}-dev
image: ekumenlabs/gz_ekumen_worlds-${ROSDISTRO:-humble}-dev
hostname: gz_ekumen_worlds-${ROSDISTRO:-humble}-dev
container_name: gz_ekumen_worlds-${ROSDISTRO:-humble}-dev
environment:
- DISPLAY
- QT_X11_NO_MITSHM=1
Expand All @@ -22,7 +22,7 @@ services:
volumes:
- /tmp/.X11-unix:/tmp/.X11-unix:rw
- /tmp/.docker.xauth:/tmp/.docker.xauth
- ..:/home/developer/ws/src/gz-worlds
- ..:/home/developer/ws/src/gz_ekumen_worlds
- gz-fuel-cache:/home/developer/.gz
deploy:
resources:
Expand Down
2 changes: 1 addition & 1 deletion docker/images/humble/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ FROM ros:humble-ros-base-jammy AS cacher

WORKDIR /ws/src

COPY . gz-worlds/
COPY . gz_ekumen_worlds/

RUN mkdir -p /tmp/ws/src \
&& find ./ -name "package.xml" | xargs cp --parents -t /tmp/ws/src \
Expand Down
2 changes: 1 addition & 1 deletion docker/images/jazzy/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ FROM ros:jazzy-ros-base-noble AS cacher

WORKDIR /ws/src

COPY . gz-worlds/
COPY . gz_ekumen_worlds/

RUN mkdir -p /tmp/ws/src \
&& find ./ -name "package.xml" | xargs cp --parents -t /tmp/ws/src \
Expand Down
4 changes: 2 additions & 2 deletions docker/run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,6 @@ done
# https://github.com/docker/compose/releases/tag/v2.13.0.
# We have this for convenience and compatibility with previous versions.
# Otherwise, we could just forward the script arguments to the run verb.
[[ "$BUILD" = true ]] && docker compose build gz-worlds-dev
[[ "$BUILD" = true ]] && docker compose build gz_ekumen_worlds-dev

PRIVILEGED_CONTAINER=$PRIVILEGED_CONTAINER USERID=$(id -u) GROUPID=dialout docker compose run --rm gz-worlds-dev
PRIVILEGED_CONTAINER=$PRIVILEGED_CONTAINER USERID=$(id -u) GROUPID=dialout docker compose run --rm gz_ekumen_worlds-dev
Empty file removed gz-ekumen/README.md
Empty file.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# limitations under the License.

cmake_minimum_required(VERSION 3.7)
project(gz-ekumen)
project(gz_ekumen_worlds)

find_package(ament_cmake REQUIRED)

Expand Down
2 changes: 1 addition & 1 deletion gz-ekumen/package.xml → gz_ekumen_worlds/package.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
<package format="3">
<name>gz-ekumen</name>
<name>gz_ekumen_worlds</name>
<version>0.1.0</version>
<description>Useful Gazebo worlds and models</description>
<author email="franco.c@ekumenlabs.com">Franco Cipollone</author>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@
</camera>
</gui>
<include>
<uri>model://gz-ekumen/models/ekumen_hq4</uri>
<uri>model://gz_ekumen_worlds/models/ekumen_hq4</uri>
</include>
</world>
</sdf>
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@
</camera>
</gui>
<include>
<uri>model://gz-ekumen/models/ekumen_hq4</uri>
<uri>model://gz_ekumen_worlds/models/ekumen_hq4</uri>
</include>
<include>
<uri>https://fuel.gazebosim.org/1.0/OpenRobotics/models/Office Desk</uri>
Expand Down
Loading