From 150bb1e3063b8961f229d1ee08f58919ef5c61d8 Mon Sep 17 00:00:00 2001 From: Morgan Rockett Date: Thu, 13 Jun 2024 14:05:03 -0400 Subject: [PATCH 1/2] removed references to the deleted scripts/configure.sh file and made replacements Signed-off-by: Morgan Rockett --- .github/workflows/docker-pull.yml | 1 - docs/getting-started.md | 12 ++++++++---- scripts/build.sh | 2 +- scripts/lint.sh | 3 ++- scripts/setup-dependencies.sh | 3 +-- 5 files changed, 12 insertions(+), 9 deletions(-) diff --git a/.github/workflows/docker-pull.yml b/.github/workflows/docker-pull.yml index b2dd161c6..df696b42a 100644 --- a/.github/workflows/docker-pull.yml +++ b/.github/workflows/docker-pull.yml @@ -26,7 +26,6 @@ jobs: with: files: | Dockerfile - **/configure.sh ######################## # Build Base # diff --git a/docs/getting-started.md b/docs/getting-started.md index 6ef9063db..19b0b81f8 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -98,12 +98,15 @@ $ git push --force origin Absolutely! However, we only officially support the included docker compose files (as they mirror our automated test environment). -After cloning the code, ``scripts/configure.sh`` will attempt to configure your environment. +After cloning the code, ``scripts/install-build-tools.sh`` needs to be ran just once. It will attempt to install the necessary software tools upon which the project relies on. -**Note:** ``scripts/configure.sh`` only supports Ubuntu-based linux distributions and macOS (which depends on [Homebrew](https://brew.sh/)). +Then, ``scripts/setup-dependencies.sh`` should be run to install libraries and dependencies +to will attempt to configure your environment. + +**Note:** ``scripts/install-build-tools.sh`` only supports Ubuntu-based linux distributions and macOS (which depends on [Homebrew](https://brew.sh/)). However, it can be used as a guide to understand what you must do to get your environment setup. -In short, ``scripts/configure.sh`` does the following: +In short, ``scripts/install-build-tools.sh`` does the following: * installs a couple packages needed for building and testing (e.g., clang, LLVM, cmake, make, lcov, googletest, git) * installs the external dependencies: @@ -127,7 +130,8 @@ However, here are several things you can do to make review as easy and quick as * Keep your working branch up-to-date with our main branch and free of merge conflicts * Run ``./scripts/lint.sh`` and ``./scripts/test.sh`` and ensure both succeed before committing changes - * You can use a tool like [`act`](https://github.com/nektos/act) to run the CI locally and see if your changes would pass automated-review +* Run ``pylint $(git ls-files '*.py')`` for python code and seek scores close to 10.0. + * You can use a tool like [`act`](https://github.com/nektos/act) to run the CI locally and see if your changes would pass automated-review. ``act --list`` to see workflow jobs. * Author [good commits](#what-does-a-good-commit-look-like) diff --git a/scripts/build.sh b/scripts/build.sh index 879f346e5..90d07991d 100755 --- a/scripts/build.sh +++ b/scripts/build.sh @@ -33,7 +33,7 @@ fi echo "Building..." -# see PREFIX in ./scripts/configure.sh +# see PREFIX in ./scripts/setup-dependencies.sh PREFIX="$(cd "$(dirname "$0")"/.. && pwd)/prefix" if [ -z ${BUILD_DIR+x} ]; then diff --git a/scripts/lint.sh b/scripts/lint.sh index cdc566c98..515ac57b1 100755 --- a/scripts/lint.sh +++ b/scripts/lint.sh @@ -29,7 +29,8 @@ check_format_files=$(git ls-files | grep -E "tools|tests|src|cmake-tests" \ clang-format --style=file --Werror --dry-run ${check_format_files[@]} if ! command -v clang-tidy &>/dev/null; then - echo "clang-tidy does not appear to be installed. Please run ./scripts/configure.sh to install dependencies or install manually." + echo "clang-tidy does not appear to be installed" + echo "Please run ./scripts/setup-dependencies.sh to install dependencies or install manually." exit 1 fi diff --git a/scripts/setup-dependencies.sh b/scripts/setup-dependencies.sh index 1e20e131b..620eae75c 100755 --- a/scripts/setup-dependencies.sh +++ b/scripts/setup-dependencies.sh @@ -9,8 +9,7 @@ end="\033[0m" set -e # install in a custom prefix rather than /usr/local. by default, this -# chooses "prefix" directory alongside "scripts" where configure.sh -# resides. +# chooses "prefix" directory alongside "scripts" directory. PREFIX="$(cd "$(dirname "$0")"/.. && pwd)/prefix" echo "Will install local dependencies in the following prefix: $PREFIX" From 96243297aa30376be6fa2e27e0d37a5912b93991 Mon Sep 17 00:00:00 2001 From: Michael Maurer Date: Mon, 24 Jun 2024 13:38:40 -0400 Subject: [PATCH 2/2] docs: fix errant instruction in parsec user guide Co-authored-by: Nicole Li Signed-off-by: Michael Maurer --- docs/parsec_user_guide.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/parsec_user_guide.md b/docs/parsec_user_guide.md index 4a7ec7e50..b2304ea50 100644 --- a/docs/parsec_user_guide.md +++ b/docs/parsec_user_guide.md @@ -27,7 +27,8 @@ If you are using MacOS or an Ubuntu-like distribution, you can run the system wi Build and run the system: ```console -$ ./scripts/configure.sh # only necessary on initial setup +# ./scripts/install-build-tools.sh # only necessary on initial setup +$ ./scripts/setup-dependencies.sh # only necessary on initial setup $ ./scripts/build.sh $ ./scripts/parsec-run-local.sh [OPTIONS] # use --help flag for help ```