chore: Update the contribution guidelines (and small fixes) #2753

sfc-gh-asawicki · 2024-04-29T16:35:30Z

The main part of the change is refreshing the outdated contribution guidelines. Note, that part on advanced debugging was just improved with the building instructions and will be validated separately (because it was updated not that long ago). Keep in mind, that this can be an iterative process, we can still improve them but we should have a good, refreshed based already.

Additionally, the TODO comments were updated and enriched with the proper ticket references.

gitguardian · 2024-04-29T16:35:34Z

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request

GitGuardian id	GitGuardian status	Secret	Commit	Filename
10577203	Triggered	Snowflake Credentials	`b847c1c`	test.env.example	View secret

🛠 Guidelines to remediate hardcoded secrets

Understand the implications of revoking this secret by investigating where it is used in your code.
Replace and store your secret safely. Learn here the best practices.
Revoke and rotate this secret.
If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

following these best practices for managing and storing secrets including API keys and other credentials
install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!}

github-actions · 2024-04-29T16:37:32Z

Integration tests cancelled for b847c1c5379c30270f26e577d6a62ca6ad898698

sfc-gh-jcieslak · 2024-04-29T17:22:10Z

CONTRIBUTING.md

 ```

-**Note: PRs for new resources will not be accepted without passing acceptance tests.**
+To be able to run all the tests you additionally need two more profiles `[secondary_test_account]` and `[incorrect_test_profile]`:


Maybe it would be worth mentioning that some of the tests require the privileged role (preferably theACCOUNTADMIN) and certain Snowflake Edition (preferably the highest available).

Good point, I will add it.

sfc-gh-jcieslak · 2024-04-29T17:23:46Z

CONTRIBUTING.md

+- `make test-acceptance` run acceptance tests
+- `make test-integration` run integration tests
+
+You can run the particular tests form inside your chosen IDE but remember that you have to set `TF_ACC=1` environment variable to run any acceptance tests (the above commands set it for you).


also having the TF_LOG=DEBUG set up helps with making sure that the right SQLs are being run.

Good point, I will add this too.

github-actions · 2024-04-29T21:49:17Z

Integration tests failure for dbbc9f5882222c71e209e8d803acea5749266188

sfc-gh-jmichalak · 2024-04-30T07:31:20Z

README.md

+
+Releases will be performed as needed, typically once every 2 weeks.
+
+Releases are published to [the terraform registry](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest). Each change has its own release notes (e.g. https://github.com/Snowflake-Labs/terraform-provider-snowflake/releases/tag/v0.89.0) and migration guide if needed (e.g. https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/MIGRATION_GUIDE.md#v0880--v0890).


Links shouldn't point to specific versions which will be quickly obsolete. E.g. https://github.com/Snowflake-Labs/terraform-provider-snowflake/releases, https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/MIGRATION_GUIDE.md

Why not? These are just examples, and we won't remove either of them.

🤖 I have created a release *beep* *boop* --- ## [0.90.0](v0.89.0...v0.90.0) (2024-05-08) ### 🎉 **What's new:** * Adjust owner_role_type and schema_evolution_record columns ([#2740](#2740)) ([424e393](424e393)) ### 🔧 **Misc** * Add a guide on creating issues ([#2758](#2758)) ([2b006aa](2b006aa)) * Add missing documentation ([#2781](#2781)) ([cc0a6a7](cc0a6a7)) * Add scripts to close issues from Pre Snowflake bucket ([#2762](#2762)) ([44c0c37](44c0c37)) * Add small adjustments ([#2783](#2783)) ([e5b0b4b](e5b0b4b)) * Adjust issue templates ([#2748](#2748)) ([64ab76d](64ab76d)) * Cleanup helpers part 3 ([#2730](#2730)) ([eb7bee4](eb7bee4)) * Cleanup helpers part 5 ([#2744](#2744)) ([1f165bf](1f165bf)) * Cleanup helpers part4 ([#2741](#2741)) ([9475e35](9475e35)) * Cleanup helpers part6 ([#2745](#2745)) ([eba3029](eba3029)) * Cleanup helpers poc ([#2724](#2724)) ([70b99fb](70b99fb)) * Helpers cleanup continuation ([#2726](#2726)) ([a70d1af](a70d1af)) * Prepare new roadmap entry ([#2773](#2773)) ([b0bf28f](b0bf28f)) * Prepare parallel builds ([#2737](#2737)) ([6974e25](6974e25)) * Update the contribution guidelines (and small fixes) ([#2753](#2753)) ([aafdc72](aafdc72)) ### 🐛 **Bug fixes:** * Fix issue templates ([#2760](#2760)) ([d0d5048](d0d5048)) * Fix setup for two tests ([#2757](#2757)) ([df025b0](df025b0)) * Fix Test (wrong order of arguments) ([#2780](#2780)) ([02f467e](02f467e)) * Fix/prove issues [#2733](#2733) [#2735](#2735) [#2763](#2763) [#2767](#2767) ([#2777](#2777)) ([7b1c67e](7b1c67e)) * Prove problems with procedure resource data types ([#2782](#2782)) ([68d0318](68d0318)) * read after create ([#2718](#2718)) ([2e9b68f](2e9b68f)) * UNSET and empty SET in network policies ([#2759](#2759)) ([3eacb0b](3eacb0b)) * unset network policy should not have single quotes ([#2584](#2584)) ([8f2a363](8f2a363)) * Update failover group allowed integration types ([#2776](#2776)) ([efde48d](efde48d)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: snowflake-release-please[bot] <105954990+snowflake-release-please[bot]@users.noreply.github.com>

sfc-gh-asawicki added 5 commits April 29, 2024 18:32

Remove/update comments regarding materialized views

938fe98

Remove/update comments regarding notification integrations

d030e0a

Remove/update comments regarding table resources

e8e0c1f

Remove/update comments regarding view

cdf5ada

Update the contribution guidelines

b847c1c

sfc-gh-asawicki requested a review from sfc-gh-jcieslak April 29, 2024 16:35

sfc-gh-asawicki marked this pull request as ready for review April 29, 2024 16:36

sfc-gh-asawicki changed the title ~~chore: Update contribution guidelines (and small fixes)~~ chore: Update the contribution guidelines (and small fixes) Apr 29, 2024

sfc-gh-jcieslak reviewed Apr 29, 2024

View reviewed changes

Fix after review

dbbc9f5

sfc-gh-asawicki requested a review from sfc-gh-jcieslak April 29, 2024 20:40

sfc-gh-jmichalak approved these changes Apr 30, 2024

View reviewed changes

sfc-gh-jcieslak approved these changes Apr 30, 2024

View reviewed changes

sfc-gh-asawicki merged commit aafdc72 into main Apr 30, 2024
8 of 9 checks passed

sfc-gh-asawicki deleted the update-contribution-guidelines branch April 30, 2024 07:41

snowflake-release-please bot mentioned this pull request Apr 30, 2024

chore(main): release 0.90.0 #2725

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Update the contribution guidelines (and small fixes) #2753

chore: Update the contribution guidelines (and small fixes) #2753

sfc-gh-asawicki commented Apr 29, 2024 •

edited

Loading

gitguardian bot commented Apr 29, 2024 •

edited

Loading

github-actions bot commented Apr 29, 2024

sfc-gh-jcieslak Apr 29, 2024

sfc-gh-asawicki Apr 29, 2024

sfc-gh-jcieslak Apr 29, 2024

sfc-gh-asawicki Apr 29, 2024

github-actions bot commented Apr 29, 2024

sfc-gh-jmichalak Apr 30, 2024

sfc-gh-asawicki Apr 30, 2024 •

edited

Loading


		Releases will be performed as needed, typically once every 2 weeks.

		Releases are published to [the terraform registry](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest). Each change has its own release notes (e.g. https://github.com/Snowflake-Labs/terraform-provider-snowflake/releases/tag/v0.89.0) and migration guide if needed (e.g. https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/MIGRATION_GUIDE.md#v0880--v0890).

chore: Update the contribution guidelines (and small fixes) #2753

chore: Update the contribution guidelines (and small fixes) #2753

Conversation

sfc-gh-asawicki commented Apr 29, 2024 • edited Loading

gitguardian bot commented Apr 29, 2024 • edited Loading

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

github-actions bot commented Apr 29, 2024

sfc-gh-jcieslak Apr 29, 2024

Choose a reason for hiding this comment

sfc-gh-asawicki Apr 29, 2024

Choose a reason for hiding this comment

sfc-gh-jcieslak Apr 29, 2024

Choose a reason for hiding this comment

sfc-gh-asawicki Apr 29, 2024

Choose a reason for hiding this comment

github-actions bot commented Apr 29, 2024

sfc-gh-jmichalak Apr 30, 2024

Choose a reason for hiding this comment

sfc-gh-asawicki Apr 30, 2024 • edited Loading

Choose a reason for hiding this comment

sfc-gh-asawicki commented Apr 29, 2024 •

edited

Loading

gitguardian bot commented Apr 29, 2024 •

edited

Loading

sfc-gh-asawicki Apr 30, 2024 •

edited

Loading