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

Project directory cleanup #2134

Merged
merged 6 commits into from
May 24, 2024
Merged

Project directory cleanup #2134

merged 6 commits into from
May 24, 2024

Conversation

sdushantha
Copy link
Member

Cleaned up the project's directory to keep things tidy. More files will be removed once #2111 has been merged

This script is only executed by the GitHub workflow. Keeping it inside
the scripts directory makes the project's directory cleaner. Additionally,
it decreases the chance of contributers executing the script even though
its harmless.
This was an example docker-compose.yml file. This example is also
available in ./docs/INSTALL.md. So keeping the file is just redundant
@sdushantha sdushantha requested a review from ppfeister May 24, 2024 10:04
Copy link
Member

@ppfeister ppfeister left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thoughts on /devel/ or similar rather than /scripts/?

Implies that whatever is contained shouldn't be relied upon at runtime or used by the normal user

Also, whatever the directory is named, can you include it in .dockerignore

I assume the relative path changes you made to site-list work, but this will likely break CI as well. Rel path in .github/workflows/update-site-list.yml should be updated to whatever the dir name is here.

@sdushantha
Copy link
Member Author

@ppfeister The changes you have suggested have been made

Copy link
Member

@ppfeister ppfeister left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I forget to mention the readme header. Updated that one.

LGTM

@sdushantha sdushantha merged commit 9b84a78 into master May 24, 2024
3 checks passed
@sdushantha sdushantha deleted the dir-cleanup branch May 24, 2024 20:07
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.

None yet

2 participants