Skip to content

Commit 3916a48

Browse files
anmolnagpalanmolnagpal
committed
docs: add docs, examples, standardize workflows and github templates
1 parent 73adceb commit 3916a48

File tree

16 files changed

+372
-31
lines changed

16 files changed

+372
-31
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or unexpected behavior in this module
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Describe the Bug
10+
A clear and concise description of what the bug is.
11+
12+
## Steps to Reproduce
13+
1. Module configuration used (sanitize any secrets)
14+
2. Command run (e.g. `terraform apply`)
15+
3. See error
16+
17+
## Expected Behavior
18+
What you expected to happen.
19+
20+
## Actual Behavior
21+
What actually happened. Include the full error message/stack trace if applicable.
22+
23+
## Environment
24+
- Terraform / OpenTofu version:
25+
- Provider version (`digitalocean/digitalocean`):
26+
- Module version / git ref:
27+
- OS:
28+
29+
## Additional Context
30+
Any other context, logs, or screenshots that might help diagnose the issue.

‎.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: CloudDrove Community
4+
url: https://clouddrove.com
5+
about: For general questions and community support.
6+
- name: DigitalOcean Terraform Provider Docs
7+
url: https://registry.terraform.io/providers/digitalocean/digitalocean/latest/docs
8+
about: Official DigitalOcean Terraform provider documentation.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement for this module
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Summary
10+
A clear and concise description of the feature you're requesting.
11+
12+
## Problem / Motivation
13+
Describe the problem this feature would solve or the use case it enables.
14+
15+
## Proposed Solution
16+
Describe the solution you'd like. Include example Terraform/OpenTofu configuration if possible.
17+
18+
## Alternatives Considered
19+
List any alternative approaches or workarounds you've already tried.
20+
21+
## Additional Context
22+
Any other context, links to upstream provider docs, or related issues.

‎.github/workflows/automerge.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: Auto merge
22
on:
33
pull_request:
4-
permissions:
4+
permissions:
55
contents: write
66
checks: read
77
pull-requests: write
@@ -12,4 +12,4 @@ jobs:
1212
azure_cloud: true
1313
tfchecks_azure: '["tf-lint / tflint"]'
1414
secrets:
15-
GITHUB: ${{ secrets.GITHUB }}
15+
GITHUB: ${{ secrets.GITHUB }}

‎.github/workflows/checkov.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
name: Security Scan
22

3-
on:
4-
pull_request:
3+
on:
4+
pull_request:
55
branches: [master]
66
types: [opened, synchronize]
77

8-
jobs:
8+
jobs:
99
checkov:
1010
uses: clouddrove/github-shared-workflows/.github/workflows/checkov.yml@88efd7724e007c8f721a219498be29e0c9ad471b # pinned to latest
1111
with:
1212
directory: '.'
1313
continue_on_error: 'true'
14-
skip_check: 'CKV_TF_1'
14+
skip_check: 'CKV_TF_1'

‎.github/workflows/gitleaks-pr-scan.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ permissions:
99

1010
jobs:
1111
gitleaks:
12-
uses: clouddrove/github-shared-workflows/.github/workflows/gitleaks-pr-scan.yml@1754bbe224200aa1d820cdf795d42de54b34245f
12+
uses: clouddrove/github-shared-workflows/.github/workflows/gitleaks-pr-scan.yml@62909fc10e105bba5cba4ff73b03c020b97789d4 # pinned to latest
1313
secrets: inherit

‎.github/workflows/module-test-harness.yml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,13 @@ permissions:
99

1010
jobs:
1111
basic-example:
12-
uses: clouddrove/github-shared-workflows/.github/workflows/stf-checks.yml@bd958ead76ac7c72acf4976c244c47eef89c84f7
12+
uses: clouddrove/github-shared-workflows/.github/workflows/stf-checks.yml@521761c1a5cf68d919980a2ed84b755182aeabfe
1313
with:
1414
provider: digitalocean
1515
working_directory: ./_examples/basic/
16+
1617
complete-example:
17-
uses: clouddrove/github-shared-workflows/.github/workflows/stf-checks.yml@bd958ead76ac7c72acf4976c244c47eef89c84f7
18+
uses: clouddrove/github-shared-workflows/.github/workflows/stf-checks.yml@521761c1a5cf68d919980a2ed84b755182aeabfe
1819
with:
1920
provider: digitalocean
2021
working_directory: ./_examples/complete/

‎.github/workflows/pr_checks.yml‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
1-
name: 'PR Validation'
1+
name: PR Validation
2+
23
on:
3-
pull_request_target:
4+
pull_request_target:
45
types:
56
- opened
67
- edited
78
- synchronize
89
- reopened
910

1011
jobs:
11-
pre-validation:
12+
pr-validation:
1213
if: github.actor != 'dependabot[bot]'
13-
uses: clouddrove/github-shared-workflows/.github/workflows/pr_checks.yml@88efd7724e007c8f721a219498be29e0c9ad471b # pinned to latest
14+
uses: clouddrove/github-shared-workflows/.github/workflows/pr_checks.yml@521761c1a5cf68d919980a2ed84b755182aeabfe # pinned to latest
1415
secrets: inherit
1516
with:
16-
subjectPattern: '^.+$'
17+
subjectPattern: '^.+$'

‎.github/workflows/stale_pr.yml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
name: 'Mark or close stale issues and PRs'
1+
name: Mark or close stale issues and PRs
22

3-
on:
3+
on:
44
schedule:
5-
- cron: '0 0 * * 5' # Runs every Friday midnight
5+
- cron: '0 0 * * 5' # Runs every Friday midnight
66
workflow_dispatch:
77

88
jobs:
99
call-shared-stale:
10-
uses: clouddrove/github-shared-workflows/.github/workflows/stale_pr.yml@88efd7724e007c8f721a219498be29e0c9ad471b # pinned to latest
11-
with:
10+
uses: clouddrove/github-shared-workflows/.github/workflows/stale_pr.yml@62909fc10e105bba5cba4ff73b03c020b97789d4 # pinned to latest
11+
with:
1212
days-before-issue-stale: 30
1313
days-before-pr-stale: 30
1414
days-before-issue-close: 10

‎.github/workflows/tag-release.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ on:
44
pull_request:
55
types: [closed]
66

7-
jobs:
7+
jobs:
88
release:
9-
uses: clouddrove/github-shared-workflows/.github/workflows/tag-release.yml@88efd7724e007c8f721a219498be29e0c9ad471b # pinned to latest
9+
uses: clouddrove/github-shared-workflows/.github/workflows/tag-release.yml@521761c1a5cf68d919980a2ed84b755182aeabfe # pinned to latest
1010
with:
1111
target_branch: master
1212
secrets:
13-
GITHUB: ${{ secrets.GITHUB_TOKEN }}
13+
GITHUB: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)