Skip to content

Commit 7bad52f

Browse files
Setup the repo for development (#1)
1 parent 8c11981 commit 7bad52f

8 files changed

Lines changed: 325 additions & 0 deletions

File tree

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @hashicorp/team-tf-ansible-integration
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
name: Bug report
3+
about: Let us know about an unexpected error, a crash, or an incorrect behavior.
4+
labels: bug
5+
---
6+
7+
<!--
8+
Hi there,
9+
10+
Thank you for opening an issue! Please note that we try to keep the this issue
11+
tracker reserved for bug reports and feature requests related to the python-tfe API
12+
wrapper. If you know your issue relates to the HCP Terraform and Terraform Enterprise
13+
platform itself, please contact tf-cloud@hashicorp.support. For general usage
14+
questions, please post to our community forum: https://discuss.hashicorp.com.
15+
-->
16+
17+
#### python-tfe version
18+
<!---
19+
What version of python-tfe are you using?
20+
-->
21+
```plaintext
22+
...
23+
```
24+
25+
## Description
26+
<!-- Describe what's happening. -->
27+
28+
## Testing plan
29+
<!--
30+
1. _Describe how to replicate_
31+
1. _the conditions under which your code performs its purpose,_
32+
1. _including example code to run where necessary._
33+
-->
34+
```plaintext
35+
...
36+
```
37+
38+
#### Expected Behavior
39+
<!--
40+
What should have happened?
41+
-->
42+
43+
#### Actual Behavior
44+
<!--
45+
What actually happened?
46+
-->
47+
48+
#### Additional Context
49+
<!--
50+
Is there anything atypical about your situation that we should know? For
51+
example: is Terraform running in a wrapper script or in a CI system? Are you
52+
passing any unusual command line options or environment variables to opt-in to
53+
non-default behavior?
54+
-->

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: HCP Terraform and Terraform Enterprise Troubleshooting and Feature Requests
4+
url: https://support.hashicorp.com/hc/en-us/requests/new
5+
about: For issues and feature requests concerning the HCP Terraform and Terraform Enterprise platform itself, please submit a HashiCorp support request or email tf-cloud@hashicorp.support
6+
- name: Terraform Language or Workflow Questions
7+
url: https://discuss.hashicorp.com
8+
about: Please ask Terraform language or workflow related questions through the HashiCorp Discuss forum
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: Feature request
3+
about: Suggest a new feature or other enhancement.
4+
labels: feature-request
5+
---
6+
7+
<!--
8+
Hi there,
9+
10+
Thank you for opening an issue! Please note that we try to keep the this issue tracker reserved for
11+
bug reports and feature requests related to the python-tfe API wrapper. If you know
12+
your issue relates to the HCP Terraform and Terraform Enterprise platform itself, please contact
13+
tf-cloud@hashicorp.support. For general usage questions, please post to our community forum:
14+
https://discuss.hashicorp.com.
15+
-->
16+
17+
18+
#### Use-cases
19+
<!---
20+
In order to properly evaluate a feature request, it is necessary to understand the use-cases for it.
21+
22+
Please describe below the _end goal_ you are trying to achieve that has led you to request this feature.
23+
24+
Please keep this section focused on the problem and not on the suggested solution. We'll get to that in a moment, below!
25+
-->
26+
27+
#### Attempted Solutions
28+
<!---
29+
If you've already tried to solve the problem with existing features and found a limitation that prevented you from succeeding, please describe it below in as much detail as possible.
30+
31+
Ideally, this would include real configuration snippets that you tried, real Terraform command lines you ran, and what results you got in each case.
32+
33+
Please remove any sensitive information such as passwords before sharing configuration snippets and command lines.
34+
-->
35+
36+
#### Proposal
37+
<!---
38+
If you have an idea for a way to address the problem via a change to this library, please describe it below.
39+
40+
In this section, it's helpful to include specific examples of how what you are suggesting might look in your code since that allows us to understand the full picture of what you are proposing.
41+
42+
If you don't know what you'd propose or are unsure of some details, don't worry! When we evaluate the feature request we'll be happy to help.
43+
-->

.github/dependabot.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
version: 2
3+
4+
updates:
5+
- package-ecosystem: "github-actions"
6+
directory: "/"
7+
schedule:
8+
interval: "weekly"

.github/pull_request_template.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
<!--
2+
Thank you for contributing to hashicorp/python-tfe! Please read docs/CONTRIBUTING.md for detailed information when preparing your change.
3+
4+
Here's what to expect after the pull request is opened:
5+
6+
The test suite contains many acceptance tests that are run against a test version of HCP Terraform, and additional testing is done against Terraform Enterprise. You can read more about running the tests against your own Terraform Enterprise environment in TESTS.md. Our CI system (Github Actions) will not test your fork until a one-time approval takes place.
7+
8+
Your change, depending on its impact, may be released in the following ways:
9+
10+
1. For impactful bug fixes, it can be released fairly quickly as a patch release.
11+
2. For noncritical bug fixes and new features, it will be incorporated into the next minor version release.
12+
3. For breaking changes (those changes that alter the public method signatures), more consideration must be made and alternatives may be considered, depending on upgrade difficulty and release schedule.
13+
14+
Please note that API features that are not generally available should not be merged/released without prior discussion with the maintainers. See docs/CONTRIBUTING Section "Adding API changes that are not generally available" for more information.
15+
16+
Please fill out the remaining template to assist code reviewers and testers with incorporating your change. If a section does not apply, feel free to delete it.
17+
-->
18+
19+
## Description
20+
21+
<!-- Describe why you're making this change. -->
22+
23+
## Testing plan
24+
25+
<!--
26+
1. _Describe how to replicate_
27+
1. _the conditions under which your code performs its purpose,_
28+
1. _including example code to run where necessary._
29+
-->
30+
31+
## External links
32+
33+
<!--
34+
_Include any links here that might be helpful for people reviewing your PR. If there are none, feel free to delete this section._
35+
36+
- [API documentation](https://developer.hashicorp.com/terraform/cloud-docs/api-docs/xxxx)
37+
- [Related PR](https://github.com/terraform-providers/terraform-provider-tfe/pull/xxxx)
38+
39+
-->
40+
41+
## Output from tests
42+
Including output from tests may require access to a TFE instance. Ignore this section if you have no environment to test against.
43+
44+
<!--
45+
_Please run the tests locally for any files you changes and include the output here._
46+
-->
47+
```
48+
...
49+
```
50+
51+
<!-- heimdall_github_prtemplate:grc-pci_dss-2024-01-05 -->
52+
## Rollback Plan
53+
54+
<!--
55+
Please outline a plan in the event changes need to be rolled back
56+
57+
Example: If a change needs to be reverted, we will roll out an update to the code within 7 days.
58+
-->
59+
60+
## Changes to Security Controls
61+
62+
<!--
63+
Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.
64+
-->

.gitignore

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
# Mac specific
2+
.DS_Store
3+
4+
# python specific
5+
__pycache__
6+
.coverage
7+
coverage_results
8+
.coverage*
9+
coverage.xml
10+
htmlcov
11+
.venv
12+
.pyre
13+
.pytest_cache/
14+
15+
# Visual Studio Code
16+
.vscode/
17+
.env
18+
19+
# build artifacts
20+
**/test-results/**
21+
blu-server-coverage.tgz
22+
.artifacts/**
23+
dist/**
24+
**/sqlite_test.db
25+
.container-id
26+
docker-artifacts/**
27+
portal.zip
28+
analyzer.zip
29+
ngrok.log
30+
31+
# portal copy
32+
static/server-version.txt
33+
34+
# other cloned repos
35+
.repos/**
36+
37+
38+
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
39+
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
40+
.idea/
41+
*.iml
42+
43+
# File-based project format
44+
*.iws
45+
46+
# IntelliJ
47+
out/
48+
49+
# mpeltonen/sbt-idea plugin
50+
.idea_modules/
51+
52+
# JIRA plugin
53+
atlassian-ide-plugin.xml
54+
55+
56+
### Vim ###
57+
# Swap
58+
[._]*.s[a-v][a-z]
59+
[._]*.sw[a-p]
60+
[._]s[a-rt-v][a-z]
61+
[._]ss[a-gi-z]
62+
[._]sw[a-p]
63+
64+
# Session
65+
Session.vim
66+
Sessionx.vim
67+
68+
# Temporary
69+
.netrwhist
70+
*~
71+
# Auto-generated tag files
72+
tags
73+
# Persistent undo
74+
[._]*.un~
75+
76+
# Database stuff
77+
database/postgresql-*.jar
78+
79+
# OS stuff
80+
*.pid
81+
82+
# Profile files
83+
profiles
84+
85+
# Pyenv
86+
# .python-version is needed by setup-python GH action
87+
# .python-version
88+
89+
# Binaries for programs and plugins
90+
*.exe
91+
*.exe~
92+
*.dll
93+
*.so
94+
*.dylib
95+
96+
# Cached build artifacts from the Go build system
97+
.cache
98+
99+
# Test binary, build with `go test -c`
100+
*.test
101+
102+
# Output of the go coverage tool, specifically when used with LiteIDE
103+
*.out
104+
105+
# OS-specific files
106+
.DS_Store
107+
108+
# Repo-specific
109+
bin/
110+
111+
# Generated protoset files
112+
*.protoset
113+
114+
# Root vendor directory generated from the Go build system
115+
/vendor
116+
117+
### Visual Studio Code ###
118+
.vscode/*
119+
!.vscode/settings.json
120+
!.vscode/launch.json
121+
!.vscode/extensions.json
122+
123+
# Ignore code-workspaces
124+
*.code-workspace
125+
/app/__pycache__/
126+
127+
# Terraform
128+
terraform/local/.terraform/**
129+
poc-terraform/.terraform
130+
poc-terraform/terraform.tfstate*
131+
132+
# Proto bin generated files
133+
protos.bin
134+
135+
# Local RSA keys
136+
.local/*

Pipfile

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[[source]]
2+
url = "https://pypi.org/simple"
3+
verify_ssl = true
4+
name = "pypi"
5+
6+
[packages]
7+
8+
[dev-packages]
9+
10+
[requires]
11+
python_version = "3.13"

0 commit comments

Comments
 (0)