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

Reorganize scripts/ folder #6429

Open
1 of 3 tasks
yurishkuro opened this issue Dec 27, 2024 · 6 comments
Open
1 of 3 tasks

Reorganize scripts/ folder #6429

yurishkuro opened this issue Dec 27, 2024 · 6 comments
Labels
enhancement good first issue Good for beginners help wanted Features that maintainers are willing to accept but do not have cycles to implement

Comments

@yurishkuro
Copy link
Member

yurishkuro commented Dec 27, 2024

The scripts/ folder accumulated many shell scripts that server different purposes. I propose to categorize them better into subfolders.

  • adaptive-sampling-integration-test.sh -> e2e/adaptive-sampling.sh
  • build-all-in-one-image.sh -> build/all-in-one-image.sh
  • build-crossdock.sh -> build/crossdock.sh
  • build-hotrod-image.sh -> build/hotrod-image.sh
  • build-upload-a-docker-image.sh -> build/upload-a-docker-image.sh
  • build-upload-docker-images.sh -> build/upload-docker-images.sh
  • cassandra-integration-test.sh -> e2e/cassandra.sh
  • check-go-version.sh -> lint/...
  • check-goleak-files.sh -> lint/...
  • check-semconv-version.sh -> lint/...
  • check-test-files.sh -> lint/...
  • clean-binaries.sh -> build/...
  • compute-tags.sh -> util/...
  • compute-tags.test.sh -> util/...
  • dco_check.py -> lint/...
  • docker-login.sh -> util/...
  • es-integration-test.sh -> e2e/elasticsearch.sh
  • import-order-cleanup.py -> lint/...
  • kafka-integration-test.sh -> e2e/kafka.sh
  • package-deploy.sh -> build/...
  • rebuild-ui.sh -> build/...
  • replace_license_headers.py -> lint/...
  • spm-integration-test.sh -> e2e/spm.sh
  • update-semconv-version.sh -> lint/...
  • updateLicense.py -> lint/...

(... means keep the original file name)

Approach:

  • Pick a single category, such as lint or e2e
  • Search the code base for where the file name is used. The most common locations are the makefiles, .github/workflows/, and other scripts
  • Move/rename scripts for a single category and update places where they are called

Categories:

  • e2e/*
  • lint/*
  • build/*
@yurishkuro yurishkuro added good first issue Good for beginners help wanted Features that maintainers are willing to accept but do not have cycles to implement labels Dec 27, 2024
@dosubot dosubot bot added the enhancement label Dec 27, 2024
@Ashu463
Copy link

Ashu463 commented Dec 27, 2024

Hey @yurishkuro I'd like to complete this task, does this folders e2e and lint needs to be created on root directory ?

@Ashu463
Copy link

Ashu463 commented Dec 27, 2024

Hey @yurishkuro I have made changes as per your description and here are their screenshot :

  • build/

Image

  • e2e/

Image

  • lint/

Image

  • util/

Image

If everything seems to be fine then please let me know I'll open PR.
Thanks !

@yurishkuro
Copy link
Member Author

does this folders e2e and lint needs to be created on root directory

no, they all should be nested under scripts/

@yurishkuro
Copy link
Member Author

If everything seems to be fine then please let me know I'll open PR.

One PR per category.

@Ashu463
Copy link

Ashu463 commented Dec 28, 2024

@yurishkuro Fixed DCO in every PR, PTAL.
Thanks !

@lekaf974
Copy link
Contributor

@Ashu463 you also need to update files referring to those scripts

yurishkuro pushed a commit that referenced this issue Dec 31, 2024
## Which problem is this PR solving?
- part of  #6429

## Description of the changes
-  organized build scripts into `scripts/build`

---------

Signed-off-by: danish9039 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement good first issue Good for beginners help wanted Features that maintainers are willing to accept but do not have cycles to implement
Projects
None yet
3 participants