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

[#208] Rename templates and skeleton folders #209

Merged
merged 6 commits into from
Aug 31, 2023

Conversation

hoangmirs
Copy link
Collaborator

@hoangmirs hoangmirs commented Aug 30, 2023

What happened 👀

  • Rename the following directories:

    • skeleton => templates
    • src/templates => src/generators
    • skeleton/core => templates/terraform
    • templates/core => generators/terraform
    • skeleton/core/base => templates/terraform/core
  • Add **/.terraform* to the template of .gitignore

Insight 📝

  • As the skeleton and templates folders might cause confusion to contributors, we should rename them to clarify them.
  • The current core folder should be terraform as it contains some main TF files.
  • The base folder of the generating project should be core, as the core will be suitable for this kind of folder to contain all infrastructure components of an environment.

Proof Of Work 📹

image

❯ tree demo-project -L 3 -I node_modules -a
demo-project
├── .github
│   ├── ISSUE_TEMPLATE
│   │   ├── bug_template.md
│   │   ├── chore_template.md
│   │   ├── feature_template.md
│   │   └── story_template.md
│   ├── PULL_REQUEST_TEMPLATE
│   │   └── release_template.md
│   ├── PULL_REQUEST_TEMPLATE.md
│   └── workflows
│       └── lint.yml
├── .gitignore
├── .tool-versions
├── core
│   ├── main.tf
│   ├── outputs.tf
│   ├── providers.tf
│   └── variables.tf
├── modules
│   ├── alb
│   │   ├── main.tf
│   │   ├── outputs.tf
│   │   └── variables.tf
│   ├── bastion
│   │   ├── main.tf
│   │   └── variables.tf
│   ├── cloudwatch
│   │   ├── main.tf
│   │   ├── outputs.tf
│   │   └── variables.tf
│   ├── ecr
│   │   ├── main.tf
│   │   ├── outputs.tf
│   │   └── variables.tf
│   ├── ecs
│   │   ├── main.tf
│   │   ├── service.json.tftpl
│   │   └── variables.tf
│   ├── iam_group_membership
│   │   ├── main.tf
│   │   └── variables.tf
│   ├── iam_groups
│   │   ├── data.tf
│   │   ├── main.tf
│   │   └── outputs.tf
│   ├── iam_users
│   │   ├── main.tf
│   │   ├── outputs.tf
│   │   └── variables.tf
│   ├── rds
│   │   ├── main.tf
│   │   ├── outputs.tf
│   │   └── variables.tf
│   ├── s3
│   │   ├── main.tf
│   │   ├── outputs.tf
│   │   └── variables.tf
│   ├── security_group
│   │   ├── main.tf
│   │   ├── outputs.tf
│   │   └── variables.tf
│   ├── ssm
│   │   ├── main.tf
│   │   ├── outputs.tf
│   │   └── variables.tf
│   └── vpc
│       ├── main.tf
│       ├── outputs.tf
│       └── variables.tf
└── shared
    ├── main.tf
    ├── outputs.tf
    ├── providers.tf
    └── variables.tf

21 directories, 54 files

@hoangmirs hoangmirs self-assigned this Aug 30, 2023
@hoangmirs hoangmirs added this to the 2.0.0 milestone Aug 30, 2023
@hoangmirs hoangmirs marked this pull request as ready for review August 30, 2023 10:12
@hoangmirs hoangmirs merged commit ffb5e57 into develop Aug 31, 2023
@hoangmirs hoangmirs deleted the chore/gh-208-rename-folders branch August 31, 2023 02:34
@hoangmirs hoangmirs mentioned this pull request Aug 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename templates and skeleton folders
3 participants