GitHub org ignore archived repos

[felixlut]

Resolves #1826

---

Before the change?

• The repositories attribute of a github_organization always included all repos in the entire Organziation, including archived ones.

After the change?

• The repositories attribute of a github_organization can now selectively ignore archived repos for the repositories attribute.

Pull request checklist

• Tests for the changes have been added (for bug fixes / features)
• Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

No

Please see our docs on breaking changes to help!

• Yes
• No

---

[felixlut]

@kfcampbell this test is based on the ones I found here, where it appears that TestCheckOutput() handles the conversions of bools and strings, i.e., false --> "false". That code uses terraform-plugin-sdk/v2, while the GitHub provider uses v1. Is there a reason for not using v2 here?

I think I read somewhere in the contribution docs that you guys don't want the developer community to mess with bumping dependencies ourselves, which is why I'm asking 😄

[kfcampbell]

The reason is due to lack of prioritization of #1780, not anything super intentional. I'm fine adding v2 as a dependency since we'll need to cut over to it anyways.

[felixlut]

So how do we move forward here? Should I wait until #1780 is merged, or import and use v2 in data_source_github_organization_test.go only (if that is even possible, haven't dealt much with golang dependencies and vendoring before)? I don't care about getting this in fast, so if it takes another couple of weeks for #1780, I'm fine to wait

[kfcampbell]

Let's move forward with your second option. The approach you describe is indeed possible and I think it's unlikely #1780 is going to be merged in the near future.

[felixlut]

I played around a bit with option 2, but I think using both v1 and v2 of the sdk is not compatible, at least not without doing some real weird stuff.

First of you need to use a version of the sdk before v2.10.1 (which released in dec 2021). Using a later version requires a bump of terraform-exec, to a version above v0.16.0, which deprecated the tfinstall package that v1 of the sdk depends on

I just go stuck with the tests using the testAccProviders (defined in github/provider_test.go), which uses v1. They cannot be used for the v2 tests in github/data_source_github_organization_test.go.

I looked into using the terraform-plugin-testing package as well, since that is the recommended solution for testing, but that seems to require v2 as well. I'm not spending anymore time investigating it, I'll wait for #1780. Unless you have some idea of how to test this feature that wont require a bump to v2?

[kfcampbell]

Oh gross...thanks for doing the legwork on that! I'm 👍 on waiting for now.

[kfcampbell]

If you're interested in picking up #1780 and fixing the build errors, please feel free! You should be able to create a new PR off of my branch if you desire.

[felixlut]

@kfcampbell that thought did cross my mind, especially since the time I spent working around it could have been enough to just make it work properly. I learnt a lot about go dependencies at least 😅

I may take a look later

[kfcampbell]

Haha, I'm glad you were able to take something positive out of it! Should you end up deciding to do so, I'd be happy to look at it.

[felixlut]

With the new release this actually works, I've tested it locally.

[felixlut]

@kfcampbell with the completion of #1780 this now works locally, along with the test for it

[kfcampbell]

I'm glad the SDK bump unblocked this work! Confirming that the added integration test is passing for me.