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

ogma-cli: Replace all occurrences of ROS2 with ROS 2. Refs #83. #84

Merged
merged 4 commits into from
Mar 24, 2023

Conversation

ivanperez-keera
Copy link
Member

Replace all occurrences of ROS2 with ROS 2 in the code, package descriptions and documentation, as prescribed in the solution proposed for #83.

The Open Source Robotics Foundation, Inc. (OSRF) has published specific
guidance on how the ROS 2 should be referred to, and they have indicated that
they would want it to be called ROS 2 instead of ROS2.

This commit replaces ROS2 with ROS 2 in the command-line help.
The Open Source Robotics Foundation, Inc. (OSRF) has published specific
guidance on how the ROS 2 should be referred to, and they have indicated that
they would want it to be called ROS 2 instead of ROS2.

This commit replaces ROS2 with ROS 2 in the package description in the cabal
file.
The Open Source Robotics Foundation, Inc. (OSRF) has published specific
guidance on how the ROS 2 should be referred to, and they have indicated that
they would want it to be called ROS 2 instead of ROS2.

This commit replaces ROS2 with ROS 2 in Ogma's README.
@ivanperez-keera
Copy link
Member Author

Change Manager: Verified that:

  • Solution is implemented:
    • The code proposed compiles passes the tests. Details:
      Docker image:

      FROM ubuntu:trusty
      
      ENV DEBIAN_FRONTEND=noninteractive
      
      RUN apt-get update
      
      RUN apt-get install --yes software-properties-common
      RUN add-apt-repository ppa:hvr/ghc
      RUN apt-get update
      
      RUN apt-get install --yes ghc-8.6.5 cabal-install-2.4
      RUN apt-get install --yes libz-dev
      
      ENV PATH=/opt/ghc/8.6.5/bin:/opt/cabal/2.4/bin:$PWD/.cabal-sandbox/bin:$PATH
      
      RUN cabal update
      RUN cabal v1-sandbox init
      RUN cabal v1-install alex happy
      RUN apt-get install --yes git
      
      # We install the application first and then test it, in case any tests need to
      # run the tool.
      CMD git clone $REPO && \
          cd $NAME && \
          git checkout $COMMIT && \
          cd .. && \
          cabal v1-install $NAME/$PAT**/ --enable-tests && \
          cabal v1-install $NAME/$PAT**/ --enable-tests --run-tests -j1

      Command:

      $ docker run -e "REPO=https://github.com/NASA/ogma" -e "NAME=ogma" -e PAT="ogma-" -e "COMMIT=7ab58a8e7a3cf118c87d6eb29df9ab5b40fa7083" -it ogma-test
    • The solution proposed fixes the issues described. Details:
      The following docker script prints Success if the text ROS2 is not found in any files except for changelog files, and nothing otherwise.

      FROM ubuntu:focal
      
      RUN apt-get update
      
      RUN apt-get install --yes git
      
      SHELL ["/bin/bash", "-c"]
      CMD git clone $REPO \
          && cd $NAME \
          && git checkout $COMMIT \
          && ! grep -nIHre 'ROS2' --exclude='CHANGELOG.md' \
          && echo "Success"

      Command:

      $ docker run -e "REPO=https://github.com/NASA/ogma" -e "NAME=ogma" -e PAT="ogma-" -e "COMMIT=7ab58a8e7a3cf118c87d6eb29df9ab5b40fa7083" -it ogma-verify-83
  • Implementation is documented. Details:
    All instances of the incorrect name replaced in README and package descriptions.
  • Change history is clear.
  • Commit messages are clear.
  • Changelogs are updated.
  • Examples are updated. Details:
    No examples affected.
  • Required version bumps are evaluated. Details:
    No bump needed (change to help/documentation term, not affecting functional aspects of the interface).

@ivanperez-keera ivanperez-keera merged commit 0207393 into develop Mar 24, 2023
@ivanperez-keera ivanperez-keera deleted the develop-rename-ros-2 branch March 24, 2023 02:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant