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

Include docs about localnet-build & localnet-start for development and testing of osmosis-core #137

Closed
MbBrainz opened this issue Jul 14, 2022 · 2 comments
Assignees
Labels
docs Improvements or additions to documentation

Comments

@MbBrainz
Copy link

Summary

I was trying to find how to run a localOsmosis version of osmosis with some customisation, but i couldn't find it anywhere in the docs. It would be nice to at least mention it at docs->build.html or preferably with some explanation/context.

Problem Definition

There is no documentation about running a localOsmosis version of Osmosis for a specific branch or some customisation.

Proposal

Add some documentation of running localOsmosis using make localnet-build and make localnet-start


@daniel-farina
Copy link
Contributor

Good call!

We need to document this https://github.com/osmosis-labs/osmosis/blob/main/Makefile

###############################################################################
###                                Localnet                                 ###
###############################################################################

localnet-keys:
	. tests/localosmosis/keys.sh

localnet-build:
	@docker build -t local:osmosis -f tests/localosmosis/Dockerfile .

localnet-build-state-export:
	@docker build -t local:osmosis-se --build-arg ID=$(ID) -f tests/localosmosis/mainnet_state/Dockerfile-stateExport .

localnet-start:
	@docker-compose -f tests/localosmosis/docker-compose.yml up

localnet-start-state-export:
	@docker-compose -f tests/localosmosis/mainnet_state/docker-compose-state-export.yml up

localnet-stop:
	@docker-compose -f tests/localosmosis/docker-compose.yml down

localnet-remove: localnet-stop
	PWD=$(shell pwd)
	@docker run --user root -v ${PWD}/tests/localosmosis/.osmosisd:/root/osmosis ubuntu /bin/sh -c "rm -rf /root/osmosis/*"

localnet-remove-state-export:
	@docker-compose -f tests/localosmosis/mainnet_state/docker-compose-state-export.yml down

.PHONY: all build-linux install format lint \
	go-mod-cache draw-deps clean build build-contract-tests-hooks \
	test test-all test-build test-cover test-unit test-race benchmark

@daniel-farina daniel-farina self-assigned this Aug 12, 2022
@daniel-farina daniel-farina added the docs Improvements or additions to documentation label Aug 12, 2022
@daniel-farina
Copy link
Contributor

Updated here
https://docs.osmosis.zone/localosmosis

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants