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!: Remove unsupported Dockerfile and instructions #420

Merged
merged 2 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 0 additions & 20 deletions .github/workflows/docker-publish.yml

This file was deleted.

5 changes: 5 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ Change history for XBlock SDK

These are notable changes in XBlock.

0.14.0 - 2024-12-16
-------------------

* remove unsupported docker instructions, as part of https://github.com/openedx/public-engineering/issues/263

0.13.0 - 2024-08-28
-------------------

Expand Down
33 changes: 0 additions & 33 deletions Dockerfile

This file was deleted.

32 changes: 0 additions & 32 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
#!/usr/bin/make -f

.PHONY: clean help quality requirements selfcheck test test-all upgrade validate
.PHONY: docker_build docker_auth docker_tag docker_push
.DEFAULT_GOAL := help

define BROWSER_PYSCRIPT
Expand Down Expand Up @@ -95,34 +94,3 @@ validate: quality test ## run tests and quality checks

selfcheck: ## check that the Makefile is well-formed
@echo "The Makefile is well-formed."

docker_build:
docker compose build

# devstack-themed shortcuts
dev.up: # Starts all containers
docker compose up -d

dev.up.build:
docker compose up -d --build

dev.down: # Kills containers and all of their data that isn't in volumes
docker compose down

dev.stop: # Stops containers so they can be restarted
docker compose stop

app-shell: # Run bash in the container as root
docker exec -u 0 -it edx.devstack.xblock-sdk bash

docker_auth:
echo "$$DOCKERHUB_PASSWORD" | docker login -u "$$DOCKERHUB_USERNAME" --password-stdin

docker_tag: docker_build
docker tag "openedx/xblock-sdk:latest" "openedx/xblock-sdk:${GITHUB_SHA}"

docker_push: | docker_auth docker_tag ## push to docker hub
echo "${GITHUB_SHA}"
docker images
docker -l debug push "openedx/xblock-sdk:latest"
docker -l debug push "openedx/xblock-sdk:${GITHUB_SHA}"
52 changes: 0 additions & 52 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,61 +62,9 @@ Locally

#. Open a web browser to: http://127.0.0.1:8000

Docker
~~~~~~

Alternatively, you can build and run the xblock-sdk in Docker (we are using docker compose which
can be installed as explained at https://docs.docker.com/compose/install/)

After cloning this repository locally, go into the repository directory and build the Docker image::

$ make docker_build

or manually run

$ docker compose build

You can then run the locally-built version using the following command::

$ make dev.up

or manually run::

$ docker compose up -d

You should now be able to access the XBlock SDK environment in your browser at http://localhost:8000

To stop the container (without removing data) by::

$ make dev.stop

or manually run::

$ docker compose stop

Note, using::

$ make dev.down

or::

$ docker compose down

will shut down the container and delete non-persistent data.

You can open a bash shell in the running container by using::

$ make app-shell

or::

$ docker container exec -it edx.devstack.xblock-sdk bash

Testing
~~~~~~~

If using Docker, all these commands need to be run inside the xblock-sdk container.
kdmccormick marked this conversation as resolved.
Show resolved Hide resolved

Testing is done via tox to test all supported versions:

#. Create and activate a virtualenv to work in.
Expand Down
19 changes: 0 additions & 19 deletions docker-compose.yml

This file was deleted.

Loading