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

Build repo: Move all .sh scripts from root folder to scripts/ folder. #2495

Open
prudhvigodithi opened this issue Aug 23, 2022 · 5 comments · May be fixed by #4099
Open

Build repo: Move all .sh scripts from root folder to scripts/ folder. #2495

prudhvigodithi opened this issue Aug 23, 2022 · 5 comments · May be fixed by #4099
Labels
enhancement New Enhancement good first issue Good for newcomers

Comments

@prudhvigodithi
Copy link
Member

prudhvigodithi commented Aug 23, 2022

Is your feature request related to a problem? Please describe

There are multiple bash scripts that are part of the root folder, there is an already exists scripts/ folder. It would be clean to move the .sh files from the root to folder and store them under scripts/.

Describe the solution you'd like

  • Move all the .sh scripts that involve the workflows to scripts/ folder.

  • Once migrated call the .sh file from the script folder.
    Example for release_notes.sh:
    Instead of ./release_notes.sh check manifests/2.2.0/opensearch-2.2.0.yml --date 2022-07-26
    Run: ./scripts/release_notes.sh check manifests/2.2.0/opensearch-2.2.0.yml --date 2022-07-26

  • To achieve this move run.sh, Pipfile Pipfile.lock to scripts/ folder.

  • Modify the .sh scripts as follows
    Example release_notes.sh

#!/bin/bash

# SPDX-License-Identifier: Apache-2.0
#
# The OpenSearch Contributors require contributions made to
# this file be licensed under the Apache-2.0 license or a
# compatible open source license.

set -e

DIR="$(dirname "$0")"
"$DIR/run.sh" "$DIR/../src/run_releasenotes_check.py" $@

Describe alternatives you've considered

No response

Additional context

No response

Acceptance Criteria

@prudhvigodithi prudhvigodithi added enhancement New Enhancement untriaged Issues that have not yet been triaged labels Aug 23, 2022
@prudhvigodithi
Copy link
Member Author

Can you please add your thoughts? This would clean the repo root folder and would better organize the scripts.
@opensearch-project/engineering-effectiveness

@peterzhuamazon
Copy link
Member

That is a huge change especially the build.sh/test.sh/assemble.sh/sign.sh etc.
A lot of the libs and code needs to accommodate this change.
Need to approach with caution, and I dont think it is very urgent to make this change right now.

@prudhvigodithi prudhvigodithi removed the untriaged Issues that have not yet been triaged label Aug 30, 2022
@prudhvigodithi
Copy link
Member Author

Similar related issue: #153

@prudhvigodithi prudhvigodithi added the good first issue Good for newcomers label Feb 27, 2023
@vchrombie
Copy link

I would like to work on this

@vchrombie
Copy link

I identified 11 scripts as of now

$ ls | grep .sh
assemble.sh
build.sh
checkout.sh
ci.sh
manifests.sh
release_notes.sh
report.sh
run.sh
sign.sh
test.sh
validation.sh

I moved them to the scripts folder and I am updating the paths.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New Enhancement good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants