Skip to content

Conversation

@rezabekf
Copy link
Contributor

@rezabekf rezabekf commented Dec 24, 2025

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:

  • Fixed make init by adding GIT_CONFIG=/dev/null to bypass system-level Git hooks configuration (required for Amazon/AWS employees)
  • Updated Makefile dependency chain to ensure pre-commit installs after venv setup completes
  • Migrated from virtualenv to uv for faster Python environment management
  • Updated .gitignore to exclude workshop instruction content
  • Removed workshop instruction files from Git tracking in the public repository
  • Updated README to prominently link to the workshop website and clarify content location

Why:

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

  • Added/Updated documentation if applicable.
  • Pre-commit checks passed.
  • Lint and Nag checks passed.
  • If releasing a new version, have you bumped the version 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.

@rezabekf rezabekf requested a review from a team as a code owner December 24, 2025 13:00
@rezabekf rezabekf self-assigned this Dec 24, 2025
@rezabekf rezabekf requested a review from a team December 24, 2025 13:47
@ctd ctd changed the title chore: remove intrernal files chore: remove internal files Dec 24, 2025
Copy link
Contributor

@ctd ctd left a 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.

Comment on lines +58 to +59
# Sync to public GitHub repo
sync:
Copy link
Contributor

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?

Copy link
Contributor Author

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
Copy link
Contributor

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added the comment, thanks 👍

@rezabekf
Copy link
Contributor Author

Thanks for the feedback Chris! I have added the more detailed explanation to README as well to PR to reflect on this major change.

@rezabekf rezabekf requested a review from ctd December 29, 2025 18:43
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.

2 participants