Skip to content

Commit

Permalink
Merge pull request #1 from komminarlabs/tk/initial-setup
Browse files Browse the repository at this point in the history
Initial repo setup
  • Loading branch information
thulasirajkomminar authored Oct 8, 2024
2 parents 76477d9 + 5375347 commit ff167ab
Show file tree
Hide file tree
Showing 19 changed files with 968 additions and 2 deletions.
152 changes: 152 additions & 0 deletions .github/ISSUE_TEMPLATE/00_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
name: "Report a Bug"
description: "Create a bug report to help us improve."
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Hi there,
Thank you for opening an issue! Please note that we try to keep the this issue tracker reserved for
bug reports and feature requests related to the CrateDB provider.
- type: markdown
attributes:
value: |
# Pulumi and CrateDB Provider Versions
- type: input
id: pulumi_version
attributes:
label: Pulumi Version
description: The semantic version of Pulumi used when experiencing the bug. If multiple versions have been tested, a comma separated list.
placeholder: "X.Y.Z"
validations:
required: true

- type: input
id: cratedb_version
attributes:
label: CrateDB Provider Version
description: The semantic version of the CrateDB Provider used when experiencing the bug. If multiple versions have been tested, a comma separated list.
placeholder: "X.Y.Z"
validations:
required: true

- type: markdown
attributes:
value: |
# Description
In the next few fields, please provide any useful information you can around what resources are affected, what you expected to happen, and what actually happened. There is also a field to optionally provide a small snippet of any relevant error or panic output.
Note that there is a section later in the form to provide more complete Pulumi configuration and logging information. These fields should instead be thought of as the place to briefly describe the bug.
- type: textarea
id: affected
attributes:
label: Affected Resource(s)
description: Please list the affected resource(s) and/or function(s).
validations:
required: false

- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: What should have happened?
validations:
required: true

- type: textarea
id: actual-behavior
attributes:
label: Actual Behavior
description: What actually happened?
validations:
required: true

- type: textarea
id: log_snippet
attributes:
label: Relevant Error/Panic Output Snippet
description: |
If applicable, provide a relevant snippet from the error or panic output. This will be rendered as `shell`, so there is no need to add a [code fence](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks).
render: shell
validations:
required: false

- type: markdown
attributes:
value: |
# Configuration and Logging
Here, we ask that you provide the Pulumi configuration and, when possible, the debug logs. For configurations or logs of more than just a few lines, it's preferred to either share a Gist link or zip the files and upload them.
Pulumi configurations or debug logs under 25MB may be [attached directly in the field](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files). Files larger than this should be uploaded to a file hosting service and a link shared.
For your security you can also encrypt the files using our [GPG public key](https://keybase.io/hashicorp).
**Note:** These form fields do not automatically render, so you will need to use [code fence(s)](https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code) to achieve proper formatting.
- type: textarea
id: tf_config
attributes:
label: Pulumi Configuration Files
description: |
Please paste, upload, or link to a file or Gist containing all Pulumi configurations required to reproduce the bug. See note above for additional information on file size restrictions and encrypting.
Bug reports without a functional reproduction may be closed without investigation.
validations:
required: true

- type: textarea
id: repro
attributes:
label: Steps to Reproduce
description: Please list the steps required to reproduce the issue.
validations:
required: true

- type: textarea
id: debug_logs
attributes:
label: Debug Output
description: |
If possible, please paste, upload, or link to a file or Gist containing debug logs. See note above for additional information on file size restrictions and encrypting.
validations:
required: false

- type: textarea
id: panic_logs
attributes:
label: Panic Output
description: If Pulumi produced a panic, please paste, upload, or link to a file or Gist containing the output of the `crash.log`.
validations:
required: false

- type: markdown
attributes:
value: |
# Additional Information
For the final two fields, optionally provide any additional context that might help the community or maintainers to investigate the bug. This might be additional references that you found when troubleshooting, similar bug reports, or specifics about your environment that might be unique.
- type: textarea
attributes:
label: Important Factoids
description: Are there anything atypical about your configuration or environment that we should know about?
validations:
required: false

- type: textarea
id: references
attributes:
label: References
description: |
Where possible, please supply links to vendor documentation, other GitHub issues (open or closed) or pull requests that give additional context.
[Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests)
validations:
required: false
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/01_feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: Feature request
about: Suggest a new feature or other enhancement.
labels: feature-request

---

<!--
Hi there,
Thank you for opening an issue! Please note that we try to keep the this issue tracker reserved for
bug reports and feature requests related to the CrateDB provider.
-->


#### Use-cases
<!---
In order to properly evaluate a feature request, it is necessary to understand the use-cases for it.
Please describe below the _end goal_ you are trying to achieve that has led you to request this feature.
Please keep this section focused on the problem and not on the suggested solution. We'll get to that in a moment, below!
-->

#### Attempted Solutions
<!---
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.
Ideally, this would include real configuration snippets that you tried, real Pulumi command lines you ran, and what results you got in each case.
Please remove any sensitive information such as passwords before sharing configuration snippets and command lines.
-->

#### Proposal
<!---
If you have an idea for a way to address the problem via a change to this provider, please describe it below.
In this section, it's helpful to include specific examples of how what you are suggesting might look in configuration files, or on the command line, since that allows us to understand the full picture of what you are proposing.
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.
-->
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Pulumi Questions
url: https://slack.pulumi.com
about: Please ask Pulumi related questions through the Pulumi Discuss forum
31 changes: 31 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
### Description
<!---
Please provide a helpful description of what change this pull request will introduce.
--->


### Relations
<!---
If your pull request fully resolves and should automatically close the linked issue, use Closes. Otherwise, use Relates.
For Example:
Relates #0000
or
Closes #0000
--->

Closes #0000

### References
<!---
Optionally, provide any helpful references that may help the reviewer(s).
--->


### Output from Acceptance Testing
```console
make test

...
```
19 changes: 19 additions & 0 deletions .github/workflows/auto-assign.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: PR
on:
issues:
types: [opened]
pull_request:
types: [opened]
jobs:
auto-assign:
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- name: 'Auto-assign issue'
uses: pozil/auto-assign-issue@v1
with:
repo-token: ${{ secrets.BOT_GITHUB_TOKEN }}
assignees: thulasirajkomminar
numOfAssignee: 1
59 changes: 59 additions & 0 deletions .github/workflows/check-upstream-upgrade.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Check upstream upgrade
on:
workflow_dispatch: {}
schedule:
- cron: 0 3 * * * # 3 AM UTC ~ 8 PM PDT / 7 PM PST daily. Time chosen to run during off hours.

env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

jobs:
check_upgrade_provider:
name: Check for upstream provider upgrades
runs-on: ubuntu-latest
steps:
- name: Install Go
uses: actions/setup-go@v5
with:
cache-dependency-path: |
sdk/go.sum
go-version: 1.22.x

- name: Checkout Repo
uses: actions/checkout@v4

- name: Unshallow clone for tags
run: git fetch --prune --unshallow --tags
shell: bash

- name: Install upgrade-provider
run: go install github.com/pulumi/upgrade-provider@main
shell: bash

- name: "Set up git identity: name"
run: git config --global user.name pulumi-bot
shell: bash

- name: "Set up git identity: email"
run: git config --global user.email [email protected]
shell: bash

- name: Run upgrade-provider upstream check
id: upstream_version
run: |
upgrade-provider "$REPO" --kind=check-upstream-version
env:
REPO: ${{ github.repository }}
shell: bash

- name: Send Check Version Failure To Slack
if: failure()
uses: rtCamp/action-slack-notify@v2
env:
SLACK_CHANNEL: provider-upgrade-publish-status
SLACK_COLOR: "#FF0000"
SLACK_ICON_EMOJI: ":owl:"
SLACK_MESSAGE: " Failed to check upstream for a new version "
SLACK_TITLE: ${{ github.event.repository.name }} upstream version check
SLACK_USERNAME: provider-bot
SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK_URL }}
54 changes: 54 additions & 0 deletions .github/workflows/license.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: PR

on:
pull_request:
branches:
- main
paths-ignore:
- docs/**
- .devcontainer/**
- examples/**
- .github/**

jobs:
license_check:
name: License Check
runs-on: ubuntu-latest
steps:
- run: ls -all

- name: Checkout
uses: actions/checkout@v4

- name: Install Go
uses: actions/setup-go@v5
with:
cache-dependency-path: |
sdk/go.sum
go-version: 1.22.x

- run: make upstream

- name: License Check
uses: pulumi/license-check-action@main
with:
module-path: provider
ignore-modules: >-
github.com/aead/chacha20,
github.com/apache/arrow/go/v12,
github.com/apache/thrift/lib/go/thrift,
github.com/cloudflare/circl,
github.com/golang,
github.com/gorhill/cronexpr,
github.com/in-toto/in-toto-golang,
github.com/jmespath/go-jmespath,
github.com/keybase/go-crypto,
github.com/klauspost/compress,
github.com/mattn/go-localereader,
github.com/modern-go/reflect2,
github.com/pierrec/lz4,
github.com/pjbgf/sha1cd,
github.com/pulumi,
github.com/segmentio/asm,
golang.org,
github.com/komminarlabs/terraform-provider-cratedb/shim
Loading

0 comments on commit ff167ab

Please sign in to comment.