Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the README setup instructions and Make commands #405

Merged

Conversation

Baarsgaard
Copy link
Contributor

@Baarsgaard Baarsgaard commented Oct 22, 2023

I had significant trouble getting started with the development of the Provider due the README.md not being easy to read.
And I also found the local testing section using test.local to be difficult at best to make use of.

Changes:

  • Refactor README.md.

    • Remove duplicate sections (Cloning and Building).
    • Order and organise everything und the new Development Section/header.
    • Migrate to using the dev_overrides in $HOME/.terraformrc to simplify local testing, especially on existing configurations.
    • Expand on the basic Terraform project example (main.tf).
    • Remove references to unused testacc sub command.
    • Update Golang version from 1.14 -> 1.18 (The one used in the CI)
  • Refactor .goreleaser

    • fix YAMLlint errors.
    • hooks.post now calls go install . As part of the new dev_overrides workflow.
  • Removed the scripts/local-release.sh as it is no longer used anywhere.

  • 3 new GNUmakefile sub-commands.

    • setup Create the $HOME/.terraformrc automatically.
    • dev Skip compiling all versions. and uses go install .
    • clean Delete the $HOME/.terraformrc restoring normal terraform plan/apply behaviour.

@Baarsgaard Baarsgaard changed the title Update the Readme setup instructions and Makefile commands Update the README setup instructions and Make commands Oct 22, 2023
@Baarsgaard Baarsgaard force-pushed the update_development_instructions branch from 8beed3c to 2bea11e Compare October 25, 2023 19:42
@Baarsgaard
Copy link
Contributor Author

@koushik-swaminathan I seem to have forgotten about this PR.
Is this of interest to the project?
I personally had a lot of trouble contributing as the Readme was difficult to read and had to use a lot of outside resources to get started.

@koushik-swaminathan
Copy link
Contributor

Hi @Baarsgaard, it's definitely useful for the repository. Let me merge the PR :)

Copy link
Contributor

@koushik-swaminathan koushik-swaminathan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@koushik-swaminathan koushik-swaminathan merged commit e59b44f into opsgenie:master Dec 15, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants