-
Notifications
You must be signed in to change notification settings - Fork 154
chore: remove internal files #283
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
base: main
Are you sure you want to change the base?
Conversation
ctd
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change functionally looks fine. My concerns are about communicating what's changing.
Could you please update the PR description with a brief explanation that the workshop instructions files are intentionally being removed from this repository, and that they are still available to view on the workshop website. Could you please also amend the README with a similar note to make sure the workshop website is prominently linked. My concern is someone may be used to finding the full workshop content here on github and we want to make it as easy as possible for them to find the workshop site.
Referring to them as "internal files" is ambiguous IMO and we should avoid it. They might be becoming "internal" now but they weren't always.
| # Sync to public GitHub repo | ||
| sync: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this meant to be in the public repository?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I considered removing the Makefile entirely from the public repository, but opted to keep identical Makefiles in both repos to simplify the contributor setup. While the sync target only functions in the internal repository, I thought is is ok to keep it in public repo to avoid maintaining two separate versions.
|
|
||
| pre-commit: $(VENV_NAME) | ||
| $(VENV_NAME)/bin/pre-commit install | ||
| GIT_CONFIG=/dev/null $(VENV_NAME)/bin/pre-commit install |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add a comment that the GIT_CONFIG=... bit is required for Amazon/AWS corporate machines due to an internal tool.
Without that context it won't make any sense to someone why that line is there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added the comment, thanks 👍
|
Thanks for the feedback Chris! I have added the more detailed explanation to README as well to PR to reflect on this major change. |
What does this PR do and why?
This PR establishes a dual-repository workflow by removing workshop instruction files from the public GitHub repository while maintaining code templates and solutions.
Changes:
make initby addingGIT_CONFIG=/dev/nullto bypass system-level Git hooks configuration (required for Amazon/AWS employees)Makefiledependency chain to ensure pre-commit installs after venv setup completes.gitignoreto exclude workshop instruction contentWhy:
The workshop instruction files are now maintained exclusively in AWS Workshop Studio and available at https://cfn101.workshop.aws/. This repository continues to provide the code templates and solutions referenced in the workshop. This separation allows for better content management while keeping the code resources publicly accessible on GitHub for contributions.
Note:
Workshop instruction files were previously in this repository but have been moved to AWS Workshop Studio only. Users can still access the complete workshop content at the workshop website.
Issue #, if available
N/A
PR acceptance checklist
make version part=<major|minor|patch>?By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.