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: Document cabal update step in README. Refs #100. #111

Merged

Conversation

ivanperez-keera
Copy link
Member

Modify the installation instructions in README.md to include the cabal update step, as prescribed in the solution proposed for #100.

The installation instructions in the README do not mention the cabal update
step. This is confusing users unfamiliar with Haskell, since it's not obvious
that cabal should have to be updated before installing Ogma.

This commit adds an update step prior to installing any tools in the
installation instructions in the README. We use the v1 variant of the command,
for consistency with the rest of the instructions.
@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
      
      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/ivanperez-keera/ogma" -e "NAME=ogma" -e PAT="ogma-" -e "COMMIT=94a59586aaa46765fccc67d327485940154fa811" -it ogma-test
    • The solution proposed fixes the issues described. Details:
      The issue is with the documentation. We verify the solution proposed by visual inspection.

  • Implementation is documented. Details:
    No changes needed.
  • Change history is clear.
  • Commit messages are clear.
  • Changelogs are updated.
  • Examples are updated. Details:
    No examples affected.
  • Required version bumps are evaluated. Details:
    Bump not needed (change to documentation only).

@ivanperez-keera ivanperez-keera merged commit a56a2f8 into nasa:develop Nov 22, 2023
@ivanperez-keera ivanperez-keera deleted the develop-readme-cabalUpdate branch November 22, 2023 06:56
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