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.

Sign up for GitHub

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

Jump to bottom

Reorganizing Project Layout #119

Merged
merged 38 commits into from
Dec 24, 2021
Merged

Reorganizing Project Layout #119

merged 38 commits into from
Dec 24, 2021

Conversation

khaines
Copy link
Collaborator

@khaines khaines commented Dec 20, 2021 •
edited
Loading

The Focus of this PR is to reorganize the project files closer to guidance found here: https://github.com/golang-standards/project-layout

It is not a perfect shift, but this should be the largest move of files, so I wanted to get the PR in as it is.

  • Go is now set to 1.17
  • Combines project to a single go module, vs many.
  • The executable packages (containing a main.go file) have been moved under the /cmd directory.
  • Referenced libraries, have been moved to the /pkg directory. There is code in the executable packages, which can be placed in a sharable reference package; these will be moved in a future PR.
  • MAKEFILE has been updated to automatically detect the presence of a Dockerfile at build time and create the corresponding container, removing the need to hardcode docker build commands for each one.
  • Moved common build steps to a parent "build" container, which will prep the space for each application to be build and avoids duplication of copying common files to a container.

@khaines
root module & automated docker detection & building
00c200c 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
moved initcontainer to root module
7dc315c 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
moving e2e test executable to cmd path
edde070 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
moving nodeagent to cmd path
95c169f 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
moving operator to cmd path
09f7a3f 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
moving operator library to the pkg folder
c7ce04e 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
moving gameserverapi to cmd path
695ac41 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
moving allocator to cmd path
241e80f 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
doing some tidying of referenced packages
b7fb5ae 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
correcting casing of module and of references
4b8145d 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
isolating common build environment to its own image
0e95268 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
tweaking dockerfiles to work with the new process
b5a59c8 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
corrected sample docker paths for building.
601d757 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
updating makefile to create tagged containers for local deployment
4376e1b 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
go 1.17
b4a4f67 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
updating go.mod
8fd9f45 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
pathing fixes
ba66703 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
removing unneeded sudo references in makefile
e714450 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
updating github actions to use go 1.17.5
70a2974 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
updating more github action steps to reflect changes in paths
02f0fb6 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@dgkanatsios dgkanatsios self-requested a review December 21, 2021 07:13
@dgkanatsios
Copy link
Collaborator

Great work, thanks! I'll post here with findings :) Repo has a VS Code workspace, which IIRC was needed since there were multiple Go apps. Do we need it now that we have a single go.mod file?

dgkanatsios
dgkanatsios reviewed Dec 21, 2021
View reviewed changes
Makefile Show resolved Hide resolved
@khaines
one more path to update
1fa98fc 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
dgkanatsios
dgkanatsios reviewed Dec 21, 2021
View reviewed changes
Makefile Outdated Show resolved Hide resolved
dgkanatsios
dgkanatsios reviewed Dec 21, 2021
View reviewed changes
Makefile Show resolved Hide resolved
@khaines
update push target to use generated names
1749673 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
updating the create install targets
0e58fa2 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
kubebuilder compromise for pathing
a2a049f 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
updating dockerfile for operator to reflect recent update
6c59e4a 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
adjusting variables for the create-install-files target to deal with …
47d519f 
…new paths

Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
ensuring image-tag is bound for local test
3a9a80c 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
dgkanatsios
dgkanatsios reviewed Dec 22, 2021
View reviewed changes
build-env/Dockerfile Outdated Show resolved Hide resolved
@khaines
Reordering lines in build dockerfile to improve caching of modules.
99203e5 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
Using the correct variable scope for the image tag when making dev in…
327559f 
…stall files

Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
dgkanatsios
dgkanatsios reviewed Dec 23, 2021
View reviewed changes
Makefile Outdated Show resolved Hide resolved
@khaines
using the init container tag env
05e72f3 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
deleting the workspace file since it isn't needed
ecac808 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
further unification of image tag use
ea59d00 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines
fixing some operator/ paths to 'pkg/operator'
2994ab4 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
dgkanatsios
dgkanatsios reviewed Dec 24, 2021
View reviewed changes
Makefile Outdated Show resolved Hide resolved
@khaines
typo
57fa962 
Signed-off-by: Ken Haines <1144092+khaines@users.noreply.github.com>
@khaines khaines merged commit 696d449 into PlayFab:master Dec 24, 2021
@dgkanatsios dgkanatsios mentioned this pull request Dec 24, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dgkanatsios dgkanatsios dgkanatsios approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@khaines @dgkanatsios