Improved dev environment #2211

kvanzuijlen · 2023-09-02T12:41:49Z

Description

Adds a devcontainer to make setting up a proper development environment quicker

Motivation and Context

It makes sure tests and linting have been run before a commit is accepted.

How Has This Been Tested?

Tested it locally, saw the pre-commit hooks working

Checklist:

My change requires a change to the documentation or CHANGELOG.
I have updated the documentation/CHANGELOG accordingly.
I have created a feature (non-master) branch for my PR.

pkg/http/server_test.go

tuunit

Revert test removal

Dockerfile.devcontainer

.devcontainer/devcontainer.json

Dockerfile.devcontainer

go.mod

# Conflicts: # go.mod # go.sum

.devcontainer/devcontainer.json

.vscode/tasks.json

.devcontainer/devcontainer.json

pkg/http/server_test.go

.vscode/tasks.json

Co-authored-by: Jan Larwig <jan@larwig.com>

.devcontainer/Dockerfile

JoelSpeed · 2023-11-03T15:59:04Z

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:


This will only run in the dev container?

Only when pre-commit install has been ran. (postCreateCommand in devcontainer.json)

Is it possible to store all of the relevant code in the .devcontainer folder or must this live in the root?

I don't think this should be in the .devcontainer as it's not devcontainer-specific although I think it should be possible

What else would it be used for?

It can also be used for anyone who wants to use pre-commit (which is possible without using the devcontainer)

JoelSpeed · 2023-11-03T15:59:45Z

.vscode/launch.json

@@ -0,0 +1,36 @@
+{


Is having this checked in likely to cause any conflict with our dev's existing configurations?

Potentially, although the launch.json is generally advised to be added to SCM. Locally, this can be overriden using workspace settings.

Can you point to where it is advised to check it in, I've personally not worked on a project where I've seen this checked in

I myself have not worked with it a lot either, but it's done by home-assistant/core as well, from which I've largely copied this setup from. I liked it there, which is why I added it, but I'm fine with it gone as well.

Ok, lets keep it for now and we'll see how we get on

github-actions · 2024-01-07T00:07:11Z

This pull request has been inactive for 60 days. If the pull request is still relevant please comment to re-activate the pull request. If no action is taken within 7 days, the pull request will be marked closed.

JoelSpeed · 2024-01-20T18:50:23Z

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:


What else would it be used for?

JoelSpeed · 2024-01-20T18:51:27Z

.vscode/launch.json

@@ -0,0 +1,36 @@
+{


Can you point to where it is advised to check it in, I've personally not worked on a project where I've seen this checked in

.pre-commit-config.yaml

* enhancement: Change base image from alpine to distroless (oauth2-proxy#2295) * Changed base image from alpine to distroless * chore: updated Makefile * fix: removed arm/v6 and ppc64le for distroless variant * Update Dockerfile * Update Makefile * docs: Add README-section, CHANGELOG-entry and --pull to prevent caching --------- Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk> * Add possibility to encode the state param as UrlEncodedBase64 (oauth2-proxy#2312) * Add possibility to encode the state param as UrlEncodedBase64 * Update CHANGELOG.md * Update oauthproxy.go Co-authored-by: Jan Larwig <jan@larwig.com> --------- Co-authored-by: Jan Larwig <jan@larwig.com> * NGINX return 403 for sign_in (oauth2-proxy#2322) (oauth2-proxy#2323) Co-authored-by: Sven Ertel <sven.ertel@bayernwerk.de> * chore: Create sha256sum for tar instead of binary (oauth2-proxy#2343) * Create sha256sum for tar instead of binary * chore: Add checksum for binary * chore: Updated changelog --------- Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk> * Log error details when failed loading CSRF cookie (oauth2-proxy#2345) * Log error details when failed loading CSRF cookie * Add a record about this PR to CHANGELOG.md --------- Co-authored-by: Ondrej Charvat <ondrej.charvat@yunextraffic.com> Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk> * Feature - Add env variable support for alpha struct (oauth2-proxy#2375) * added envsubstring package and added simple test cases.imple tests. * added documentation * added changelog entry * added documentation to wrong file . * changed tests to ginkgo format * update project to use better maintained library * use defer to clear test variable after tests finished * updated docs for the new package documentation and fixed bad english * refactored function to "reduce" complexity. * updated changelog for new version updated readme * minor formatting --------- Co-authored-by: Haydn Evans <h.evans@douglas.de> Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk> * remove nsswitch workaround (oauth2-proxy#2371) Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk> * feat: Added renovate configuration (oauth2-proxy#2377) * Feature/add option to skip loading claims from profile url (oauth2-proxy#2329) * add new flag skip-claims-from-profile-url * skip passing profile URL if SkipClaimsFromProfileURL * docs for --skip-claims-from-profile-url flag * update flag comment * update docs * update CHANGELOG.md * Update providers/provider_data.go Co-authored-by: Jan Larwig <jan@larwig.com> * Add tests for SkipClaimsFromProfileURL * simplify tests for SkipClaimsFromProfileURL * generate alpha_config.md --------- Co-authored-by: Jan Larwig <jan@larwig.com> * Add ability to configure username for Redis cluster connections (oauth2-proxy#2381) * Initial attempt. * Add CHANGELOG entry. * Drop commented-out Sentinel test. --------- Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk> * chore(deps): update module golang.org/x/crypto to v0.17.0 [security] (oauth2-proxy#2400) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore(deps): update github.com/ghodss/yaml digest to d8423dc (oauth2-proxy#2401) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Improved dev environment (oauth2-proxy#2211) * Improved dev env setup * Cleanup duplicate checks * Applied PR feedback * Updated go.mod/go.sum * go mod tidy * Update .devcontainer/devcontainer.json * Update pkg/http/server_test.go Co-authored-by: Jan Larwig <jan@larwig.com> * Create launch.json * Update .devcontainer/Dockerfile * Apply suggestions from code review --------- Co-authored-by: Jan Larwig <jan@larwig.com> * feature: add release automation workflows (oauth2-proxy#2224) * feature: add release automation workflows * deactivate provenancee because of behaviour change with buildx v0.10.0 * add changelog section extraction for github release notes * fix registry path; fix EOF * use correct version of golangci-lint; add additional workflow step for fetching all dependencies * chore(deps): update module github.com/bsm/redislock to v0.9.4 (oauth2-proxy#2406) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * initial commit for docusaurus 3 upgrade * fix mdx errors * fix mdx issues * fix routing issues * update docs generation workflow * fix version * fix permissions * move slack to header * remove background color and minify * Update docs/docs/configuration/providers/openid_connect.md Co-authored-by: Koen van Zuijlen <8818390+kvanzuijlen@users.noreply.github.com> * Update docs/docs/configuration/providers/openid_connect.md Co-authored-by: Koen van Zuijlen <8818390+kvanzuijlen@users.noreply.github.com> * Update docs/docs/configuration/providers/openid_connect.md Co-authored-by: Koen van Zuijlen <8818390+kvanzuijlen@users.noreply.github.com> * Update docs/docs/configuration/providers/gitlab.md Co-authored-by: Koen van Zuijlen <8818390+kvanzuijlen@users.noreply.github.com> * Update docs/docs/configuration/providers/gitlab.md Co-authored-by: Koen van Zuijlen <8818390+kvanzuijlen@users.noreply.github.com> * Update docs/docs/configuration/providers/github.md Co-authored-by: Koen van Zuijlen <8818390+kvanzuijlen@users.noreply.github.com> * Update docs/docs/configuration/providers/github.md Co-authored-by: Koen van Zuijlen <8818390+kvanzuijlen@users.noreply.github.com> * Update docs/docs/configuration/providers/github.md Co-authored-by: Koen van Zuijlen <8818390+kvanzuijlen@users.noreply.github.com> * Update docs/docs/configuration/providers/github.md Co-authored-by: Koen van Zuijlen <8818390+kvanzuijlen@users.noreply.github.com> --------- Co-authored-by: Koen van Zuijlen <8818390+kvanzuijlen@users.noreply.github.com> Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk> Co-authored-by: Jan Brezina <brezinajn@users.noreply.github.com> Co-authored-by: WhiteRabbit-Code <sven@ertel-net.de> Co-authored-by: Sven Ertel <sven.ertel@bayernwerk.de> Co-authored-by: charvadzo <120425386+charvadzo@users.noreply.github.com> Co-authored-by: Ondrej Charvat <ondrej.charvat@yunextraffic.com> Co-authored-by: Haydn Evans <h.evans@douglas.de> Co-authored-by: Nils Gustav Stråbø <65334626+nilsgstrabo@users.noreply.github.com> Co-authored-by: Ross Golder <ross@golder.org> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

kvanzuijlen commented Sep 2, 2023

View reviewed changes

pkg/http/server_test.go Show resolved Hide resolved

kvanzuijlen added 2 commits September 5, 2023 21:18

Improved dev env setup

de111c9

Cleanup duplicate checks

d00bd3e

kvanzuijlen force-pushed the improved-dev-environment branch from cf55e56 to d00bd3e Compare September 5, 2023 19:18

tuunit suggested changes Sep 10, 2023

View reviewed changes

Dockerfile.devcontainer Outdated Show resolved Hide resolved

.devcontainer/devcontainer.json Show resolved Hide resolved

Dockerfile.devcontainer Outdated Show resolved Hide resolved

Dockerfile.devcontainer Outdated Show resolved Hide resolved

Applied PR feedback

b836b02

kvanzuijlen commented Sep 20, 2023

View reviewed changes

go.mod Outdated Show resolved Hide resolved

kvanzuijlen requested a review from tuunit September 20, 2023 19:59

Merge branch 'master' into improved-dev-environment

57ccfa7

kvanzuijlen marked this pull request as ready for review September 20, 2023 19:59

kvanzuijlen requested a review from a team as a code owner September 20, 2023 19:59

kvanzuijlen added 3 commits October 7, 2023 09:41

Merge branch 'master' into improved-dev-environment

3762cee

Updated go.mod/go.sum

6c08846

go mod tidy

c98d382

kvanzuijlen marked this pull request as draft October 7, 2023 08:11

kvanzuijlen added 2 commits October 24, 2023 19:15

Merge branch 'master' into improved-dev-environment

d5c1169

Merge branch 'master' into improved-dev-environment

05c6287

# Conflicts: # go.mod # go.sum

github-actions bot added go tests labels Oct 25, 2023

kvanzuijlen marked this pull request as ready for review October 25, 2023 20:43

tuunit reviewed Oct 25, 2023

View reviewed changes

.devcontainer/devcontainer.json Outdated Show resolved Hide resolved

.vscode/tasks.json Show resolved Hide resolved

kvanzuijlen commented Oct 25, 2023

View reviewed changes

.devcontainer/devcontainer.json Outdated Show resolved Hide resolved

Update .devcontainer/devcontainer.json

e4aec75

tuunit reviewed Oct 28, 2023

View reviewed changes

pkg/http/server_test.go Outdated Show resolved Hide resolved

.vscode/tasks.json Show resolved Hide resolved

Update pkg/http/server_test.go

7aea565

Co-authored-by: Jan Larwig <jan@larwig.com>

github-actions bot added the docker label Oct 28, 2023

Create launch.json

94fc908

tuunit added the LGTM PR is ready to merge label Oct 31, 2023

tuunit approved these changes Oct 31, 2023

View reviewed changes

JoelSpeed reviewed Nov 3, 2023

View reviewed changes

Update .devcontainer/Dockerfile

1aa3f98

github-actions bot added the Stale label Jan 7, 2024

github-actions bot closed this Jan 14, 2024

tuunit reopened this Jan 14, 2024

tuunit removed the Stale label Jan 14, 2024

JoelSpeed reviewed Jan 20, 2024

View reviewed changes

Apply suggestions from code review

ad8013f

JoelSpeed approved these changes Jan 20, 2024

View reviewed changes

JoelSpeed merged commit f88f09f into oauth2-proxy:master Jan 20, 2024
6 checks passed

kvanzuijlen deleted the improved-dev-environment branch January 20, 2024 21:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improved dev environment #2211

Improved dev environment #2211

kvanzuijlen commented Sep 2, 2023

tuunit left a comment

JoelSpeed Nov 3, 2023

kvanzuijlen Nov 4, 2023

JoelSpeed Nov 5, 2023

kvanzuijlen Nov 7, 2023

JoelSpeed Jan 20, 2024

kvanzuijlen Jan 20, 2024

JoelSpeed Nov 3, 2023

kvanzuijlen Nov 4, 2023

JoelSpeed Jan 20, 2024

kvanzuijlen Jan 20, 2024

JoelSpeed Jan 20, 2024

github-actions bot commented Jan 7, 2024

JoelSpeed Jan 20, 2024

JoelSpeed Jan 20, 2024

Improved dev environment #2211

Improved dev environment #2211

Conversation

kvanzuijlen commented Sep 2, 2023

Description

Motivation and Context

How Has This Been Tested?

Checklist:

tuunit left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jan 7, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment