Skip to content

Commit b95f25a

Browse files
authored
Merge pull request #3 from ZacksHomeLab/dev
ci: Initial Workflow Implementation
2 parents c12b44b + e110f10 commit b95f25a

28 files changed

+590
-36
lines changed

.editorconfig

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# EditorConfig is awesome: http://EditorConfig.org
2+
# Uses editorconfig to maintain consistent coding styles
3+
4+
# top-most EditorConfig file
5+
root = true
6+
7+
# Unix-style newlines with a newline ending every file
8+
[*]
9+
charset = utf-8
10+
end_of_line = lf
11+
indent_size = 2
12+
indent_style = space
13+
insert_final_newline = true
14+
max_line_length = 80
15+
trim_trailing_whitespace = true
16+
17+
[*.{tf,tfvars}]
18+
indent_size = 2
19+
indent_style = space
20+
21+
[*.hcl]
22+
indent_size = 2
23+
indent_size = space
24+
25+
[*.md]
26+
max_line_length = 0
27+
trim_trailing_whitespace = false
28+
29+
[Makefile]
30+
tab_width = 2
31+
indent_style = tab
32+
33+
[COMMIT_EDITMSG]
34+
max_line_length = 0

.github/CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
zack@zackshomelab.com.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

.github/CONTRIBUTING.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Contributing Guidelines
2+
3+
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.
4+
5+
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.
6+
7+
8+
## Reporting Bugs/Feature Requests
9+
10+
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
11+
12+
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
13+
14+
* A reproducible test case or series of steps
15+
* The version of our code being used
16+
* Any modifications you've made relevant to the bug
17+
* Anything unusual about your environment or deployment
18+
19+
20+
## Contributing via Pull Requests
21+
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
22+
23+
1. You are working against the latest source on the *master* branch.
24+
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
25+
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
26+
27+
To send us a pull request, please:
28+
29+
1. Fork the repository.
30+
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
31+
3. Ensure local tests pass.
32+
4. Commit to your fork using clear commit messages.
33+
5. Send us a pull request, answering any default questions in the pull request interface.
34+
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
35+
36+
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
37+
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
38+
39+
40+
## Finding contributions to work on
41+
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
42+
43+
44+
## Code of Conduct
45+
This project has adopted the [Contributor Covenant][homepage], version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
46+
47+
[homepage]: https://www.contributor-covenant.org
48+
49+
For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq
50+
51+
52+
## Licensing
53+
54+
See the LICENSE file for our project's licensing.
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
labels: bug
5+
assignees: ZacksHomeLab
6+
---
7+
8+
## Description
9+
Please provide a detailed and concise description of the issue you are facing. Additionally, include a reproduction of your configuration. If you are unable to provide your exact configuration, you can refer to the `examples/*` directory for references that can be copied, pasted, and customized to match your configurations. It is essential that the reproduction provided can be executed successfully by running `terraform init && terraform apply` without any additional modifications.
10+
11+
If your request is for a new feature, please use the `Feature request` template.
12+
13+
## ⚠️ Note ⚠️
14+
15+
**Before you submit an issue, please perform the following:**
16+
17+
- [ ] (**ONLY** if you store your state remotely) I have removed the local `.terraform` directory. This step is to insure you've re-initializing this module.
18+
- [ ] I have re-initialized the project via `terraform init`.
19+
- [ ] I have tried multiple times to run `terraform plan` and `terraform apply`, but the issue still persists.
20+
21+
## Versions
22+
23+
- (Required) Module Version:
24+
25+
- Terraform Version:
26+
<!-- Execute command: terraform -version -->
27+
- (Optional) Terragrunt Version:
28+
<!-- Execute command: terragrunt -version -->
29+
- Provider(s) Version:
30+
<!-- Execute command: terraform providers -version -->
31+
32+
## Reproduction Code [Required]
33+
34+
<!-- REQUIRED -->
35+
36+
Steps to reproduce the behavior:
37+
38+
<!-- Are you using workspaces? -->
39+
<!-- Have you cleared the local cache (see Notice section above)? -->
40+
<!-- List steps in order that led up to the issue you encountered -->
41+
42+
## Expected behavior
43+
44+
<!-- A clear and concise description of what you expected to happen -->
45+
46+
## Actual behavior
47+
48+
<!-- A clear and concise description of what actually happened -->
49+
50+
### Terminal Output Screenshot(s)
51+
52+
<!-- Optional but helpful -->
53+
54+
## Additional context
55+
56+
<!-- Add any other context about the problem here -->

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
---
5+
6+
## What additional functionality would you like?
7+
<!-- A clear and concise description of what feature you would like added. Ex. Additional parameter validations, support for specific deployments (e.g., multiple network adapters) -->
8+
9+
## Is your request related to a problem? Please describe.
10+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when ... -->
11+
12+
## Describe the solution you'd like.
13+
<!-- A clear and concise description of what you want to happen -->
14+
15+
## Describe alternatives you've considered.
16+
<!-- A clear and concise description of any alternative solutions or functionality you've considered -->
17+
18+
## Additional context
19+
<!-- Add any other context or screenshots about the feature request here -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## Description
2+
<!--- Describe your changes in detail -->
3+
4+
## Motivation and Context
5+
<!--- Why is this change required? What problem does it solve? -->
6+
<!--- If it fixes an open issue, please link to the issue here. -->
7+
8+
## Breaking Changes
9+
<!-- Does this break backwards compatibility with the current major version? -->
10+
<!-- If so, please provide an explanation why it is necessary. -->
11+
12+
## How Has This Been Tested?
13+
- [ ] I have updated at least one of the `examples/*` to demonstrate and validate my change(s).
14+
- [ ] I have tested and validated these changes using one or more of the provided `examples/*` projects.
15+
<!--- Users should start with an existing example as its written, deploy it, then check their changes against it -->
16+
<!--- This will highlight breaking/disruptive changes. Once you have checked, deploy your changes to verify -->
17+
<!--- Please describe how you tested your changes -->
18+
- [ ] I have executed `pre-commit run -a` on this pull request.
19+
<!--- Please see https://github.com/antonbabenko/pre-commit-terraform#how-to-install for how to install -->

.github/SECURITY.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## Reporting a Vulnerability
2+
3+
If you discover a potential security issue in this project please notify me via email at zack@zackshomelab.com.
4+
5+
Please do **not** create a public github issue.

.github/stale.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
# Number of days of inactivity before an issue becomes stale
3+
daysUntilStale: 90
4+
5+
# Number of days of inactivity before an stale issue is closed
6+
daysUntilClose: 30
7+
8+
# Label to use when marking an issue as stale
9+
staleLabel: stale
10+
11+
# Limit to only `issues` or `pulls`
12+
only: issues
13+
14+
issues:
15+
16+
# Comment to post when marking an issue as stale.
17+
markComment: >
18+
This issue has been automatically marked as stale because it has not had
19+
recent activity. It will be closed if no further activity occurs. Thank you
20+
for your contributions.
21+
22+
# Comment to post when closing a stale issue.
23+
closeComment: >
24+
This issue has been automatically closed because it has not had recent
25+
activity since being marked as stale.
26+
27+
pulls:
28+
29+
# Comment to post when marking a PR as stale.
30+
markComment: >
31+
This PR has been automatically marked as stale because it has not had
32+
recent activity. It will be closed if no further activity occurs. Thank you
33+
for your contributions.
34+
35+
To track this PR (even if closed), please open a corresponding issue if one
36+
does not already exist.
37+
38+
# Comment to post when closing a stale PR.
39+
closeComment: >
40+
This PR has been automatically closed because it has not had recent
41+
activity since being marked as stale.
42+
43+
Please reopen when work resumes.

.github/workflows/lock_threads.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: 'Lock Threads'
2+
3+
on:
4+
schedule:
5+
- cron: '15 1 * * *'
6+
7+
jobs:
8+
lock:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: dessant/lock-threads@v4
12+
with:
13+
github-token: ${{ secrets.GITHUB_TOKEN }}
14+
issue-comment: >
15+
I'm going to lock this issue because it has been closed for _30 days_ ⏳. This helps our maintainers find and focus on the active issues.
16+
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.
17+
issue-inactive-days: '30'
18+
pr-comment: >
19+
I'm going to lock this pull request because it has been closed for _30 days_ ⏳. This helps our maintainers find and focus on the active issues.
20+
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.
21+
pr-inactive-days: '30'

0 commit comments

Comments
 (0)