Skip to content

Latest commit

 

History

History
60 lines (44 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

60 lines (44 loc) · 1.47 KB
Raw

Contributing Guide

Current Maintainers

  • Caleb @cdavisgpsi
  • Josiah @Jbcampbe
  • Drew @drewlesueur
  • Daniel @robotdan (FusionAuth)

Guidline for Updating

  1. Scroll through FusionAuth's API Docs
  2. Update each resouce and make sure to update the docs!!!
  3. Make sure tests work (and maybe add new ones!)
  4. Submit PR to this repo
  5. Upon merge, maintainer will create new git tag kicking off the build process.
  6. Terraform Registry will pick up the changes
git tag v0.1.71
git push origin --tag

Running tests

The tests require 3 variables set in order to run.

TF_ACC=true
FA_DOMAIN=https://YOUR.fusionauth.io
FA_API_KEY=YOUR_API_KEY

If you add these to your computer/shell environment variables then executing the tests are as simple as:

go test ./...

Alternately you can supply on the command line when executing the tests.

TF_ACC=true FA_DOMAIN=https://YOUR.fusionauth.io FA_API_KEY=YOUR_API_KEY go test ./...

Running lint

If you want to head off lint errors before hitting CI you can execute them locally.

First, install golangci-lint. Instructions can be found here: https://golangci-lint.run/usage/install/#local-installation

Then run it:

golangci-lint run

To uppdate the FusionAuth go-client

In this example, we are pulling the go-client at version 1.42.1

go get -u github.com/FusionAuth/go-client@1.42.1