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

feat: development environment using gitpod #11835

Closed
wants to merge 9 commits into from

Conversation

faddat
Copy link
Contributor

@faddat faddat commented Apr 30, 2022

Description

Closes: #11817

This PR adds a .gitpod.yml file that uses ghcr.io/faddat/cosmos, an image built to allow the use of any aspect of cosmos. This way, in order to begin working with the sdk, users don't even need to set up a local development environment.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@faddat faddat requested a review from a team as a code owner April 30, 2022 05:03
Copy link
Contributor

@alexanderbez alexanderbez left a comment

Choose a reason for hiding this comment

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

I don't know what gitpod is, nor have I ever used it, so I don't really feel comfortable approving. Maybe someone with experience with this can chime in.

@faddat
Copy link
Contributor Author

faddat commented May 1, 2022

Totally fair, let me walk ya through:

Gitpod is a browser extension + cloud based container-runner with vscode in it.

The effect?
Screen Shot 2022-05-01 at 3 16 44 PM

When you visit a github repository (any even without the .gitpod.yml) you can click the green gitpod button and it checks out the code for you.

When you do have the .gitpod.yml file, it even knows where to run the code.

So in this case that file is a full cosmos-sdk development enviornment.

It runs that as your shell and gives you:

Screen Shot 2022-05-01 at 3 18 10 PM

I think it would be helpful for onboarding.

Users still push to their own repository, it just gets them checked out and going more quickly.

@@ -0,0 +1,9 @@
image: ghcr.io/faddat/cosmos
Copy link
Member

Choose a reason for hiding this comment

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

can you link to this image? what does it contain?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, the image is automatically built every hour here and I want to merge it into the cosmos-sdk-- the entire build system for it

https://github.com/faddat/archlinux-docker

The cosmos folder builds that image.

Copy link
Contributor Author

@faddat faddat May 2, 2022

Choose a reason for hiding this comment

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

if we merge:

#11768

Then that development environment image would be built here, hourly.

It links to an external repository only because well, to put it softly, our docker situation -- and the build situation that comes from using Dockerfiles that are muslc-based and ancient, aren't so great.

Copy link
Contributor

Choose a reason for hiding this comment

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

Let's not use external dependencies. If #11768 is a dependency, let's put this PR as draft for now, and open it again when the dep is merged.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

kk

@alexanderbez
Copy link
Contributor

I don't understand why anyone would use this TBH. I'm okay with adding a simple config file though.

@amaury1093 amaury1093 self-assigned this May 2, 2022
@faddat
Copy link
Contributor Author

faddat commented May 3, 2022

it's my primary development environment

@faddat faddat marked this pull request as draft May 3, 2022 01:23
@faddat
Copy link
Contributor Author

faddat commented May 18, 2022

Hey, so if you want to see this in action, you'd install the gitpod browser extension, and then open up the Juno or osmosis repository.

All the tooling is there, and stuff "just works"

That is the goal of the change overall.

@tac0turtle
Copy link
Member

Hey, im fine with merging this, I think the missing part for me is to figure out what all the docker image is doing.

@faddat faddat marked this pull request as ready for review June 3, 2022 17:39
@tac0turtle
Copy link
Member

Ill close this for now, lets get the docker image updated then we can reopen this

@tac0turtle tac0turtle closed this Jun 14, 2022
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.

DX: gitpod
4 participants