Skip to content

Fixed inconsistency between dev/DOCKER_DEPLOY.md and root Dockerfile #2313

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

Merged

Conversation

Kashiwade-music
Copy link
Contributor

Description

  • Update dev/DOCKER_DEPLOY.md
    • Changed the Markdown formatting style to match the rest of the files
    • Remove outdated information (such as Cloud9)
    • Change instructions to verify if VTR is installed correctly, following the guidelines in BUILDING.md.
  • Add time package install
    • Required to successfully run run_vtr_task.py
  • The target image is now based on Ubuntu 22.04, officialy recommended environment
    • CI testing is being conducted on Ubuntu 22.04

Related Issue

#1756

Motivation and Context

The Dockerfile located in the root directory of the repository has been actively revised since #1970, but the dev/DOCKER_DEPLOY.md file, which can be accessed from the root README.md, has not been updated for almost three years and contains outdated information.

Currently, the only available documentation for running VTR with Docker is dev/DOCKER_DEPLOY.md, which may cause confusion for beginners. Therefore, it needs to be updated.

How Has This Been Tested?

Ensure that VTR can be successfully built by following the steps outlined in the updated dev/DOCKER_DEPLOY.md file.

Types of changes

  • Bug fix (change which fixes an issue)
  • New feature (change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed

…file

- Added the time package and successfully passed the "./run_reg_test.py vtr_reg_basic" test as instructed in dev/DOCKER_DEPLOY.md.
- The image is now based on Ubuntu 22.04, officialy recommended environment
@github-actions github-actions bot added the infra Project Infrastructure label May 14, 2023
@vaughnbetz
Copy link
Contributor

Thanks! Sorry I didn't see and approve this earlier. The documentation updates look very good.
@AlexandreSinger : any issues with moving the dockerfile to Ubuntu 22.04? Seems like a good idea to keep moving forward; just making sure there aren't any related updates or gotchas that I've neglected.

@AlexandreSinger
Copy link
Contributor

Thanks! Sorry I didn't see and approve this earlier. The documentation updates look very good. @AlexandreSinger : any issues with moving the dockerfile to Ubuntu 22.04? Seems like a good idea to keep moving forward; just making sure there aren't any related updates or gotchas that I've neglected.

@vaughnbetz These changes make sense to me. I agree that we should maintain the docker at the same version as the CI, since that is being consistently tested. I do not expect there should be any extra updates required; it seems to include the dependencies I would expect it needs.

@vaughnbetz vaughnbetz merged commit 8f20622 into verilog-to-routing:master May 22, 2024
52 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infra Project Infrastructure
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants