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 setup instructions and remove some unused files and instructions #2685

Merged
merged 4 commits into from
Nov 11, 2024

Conversation

bbondy
Copy link
Member

@bbondy bbondy commented Oct 28, 2024

Summary

The longer term plan seems to be to make skus run in its own command.
However as it stands now in the current state a lot of the setup is broken.
This updates some outdated instructions and removes some unused things to make setup for new devs easier.

Changes include:

  • Update minimum Go version
  • go get is no longer supported outside a module, update to go install
  • Update outdated path for payments in README and remove superfluous redirection character
  • Update a couple of outdated paths in the services/skus/README.md file
  • Fix some wrong setup instructions in services/skus/README.md
  • Removes some unused commands from the Makefile and from the READMEs.

Type of Change

  • Product feature
  • Bug fix
  • Performance improvement
  • Refactor
  • Other

Tested Environments

  • Development
  • Staging
  • Production

Before Requesting Review

  • Have documented new functionality in README or in comments?
  • Have you squashed all intermediate commits?
  • Is there a clear title that explains what the PR does?
  • Have you performed a self review of this PR?

Not applicable:

  • Does your code build cleanly without any errors or warnings?
  • Have you used auto closing keywords?
  • Have you added tests for new functionality?
  • Have validated query efficiency for new database queries?
  • Have you used intuitive function, variable and other naming?
  • Have you requested security and/or privacy review if needed

Manual Test Plan

@bbondy bbondy self-assigned this Oct 28, 2024
@bbondy bbondy force-pushed the setup-updates branch 15 times, most recently from f77612f to 8dc2b41 Compare November 5, 2024 18:39
@bbondy bbondy requested a review from clD11 November 5, 2024 18:40
@bbondy bbondy changed the title WIP: Update setup instructions Update setup instructions and remove some unused files and instructions Nov 5, 2024
@bbondy bbondy force-pushed the setup-updates branch 2 times, most recently from 8aca674 to 66c0286 Compare November 5, 2024 18:47
@bbondy bbondy marked this pull request as ready for review November 5, 2024 18:49
services/skus/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@clD11 clD11 left a comment

Choose a reason for hiding this comment

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

LGTM approved.

- Update minimum Go version (all setups require at least 1.22)
- `go get` is no longer supported outside a module, update to `go install`
- Update outdated path for payments in README and remove superfluous redirection character
- Update a couple of oudated paths in the `services/skus/README.md` file
- The Makefile was referencing a yml file that didn't exist.
- The skus README was specifying a command which was previously renamed.

I removed the Makefile entry and instead specify to run `make docker-dev`
and speicfy to run `cd main && go run main.go serve grant` in the
services/sku readme.
@bbondy bbondy merged commit b2a2a8f into master Nov 11, 2024
13 checks passed
@bbondy bbondy deleted the setup-updates branch November 11, 2024 20:56
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.

2 participants