Skip to content

Commit f24b8e1

Browse files
authored
feat!: Remove unsupported Dockerfile and instructions (#420)
Part of: openedx/public-engineering#263
1 parent 57c55fc commit f24b8e1

File tree

6 files changed

+5
-156
lines changed

6 files changed

+5
-156
lines changed

.github/workflows/docker-publish.yml

-20
This file was deleted.

CHANGELOG.rst

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ Change history for XBlock SDK
44

55
These are notable changes in XBlock.
66

7+
0.14.0 - 2024-12-16
8+
-------------------
9+
10+
* remove unsupported docker instructions, as part of https://github.com/openedx/public-engineering/issues/263
11+
712
0.13.0 - 2024-08-28
813
-------------------
914

Dockerfile

-33
This file was deleted.

Makefile

-32
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
#!/usr/bin/make -f
22

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

76
define BROWSER_PYSCRIPT
@@ -95,34 +94,3 @@ validate: quality test ## run tests and quality checks
9594

9695
selfcheck: ## check that the Makefile is well-formed
9796
@echo "The Makefile is well-formed."
98-
99-
docker_build:
100-
docker compose build
101-
102-
# devstack-themed shortcuts
103-
dev.up: # Starts all containers
104-
docker compose up -d
105-
106-
dev.up.build:
107-
docker compose up -d --build
108-
109-
dev.down: # Kills containers and all of their data that isn't in volumes
110-
docker compose down
111-
112-
dev.stop: # Stops containers so they can be restarted
113-
docker compose stop
114-
115-
app-shell: # Run bash in the container as root
116-
docker exec -u 0 -it edx.devstack.xblock-sdk bash
117-
118-
docker_auth:
119-
echo "$$DOCKERHUB_PASSWORD" | docker login -u "$$DOCKERHUB_USERNAME" --password-stdin
120-
121-
docker_tag: docker_build
122-
docker tag "openedx/xblock-sdk:latest" "openedx/xblock-sdk:${GITHUB_SHA}"
123-
124-
docker_push: | docker_auth docker_tag ## push to docker hub
125-
echo "${GITHUB_SHA}"
126-
docker images
127-
docker -l debug push "openedx/xblock-sdk:latest"
128-
docker -l debug push "openedx/xblock-sdk:${GITHUB_SHA}"

README.rst

-52
Original file line numberDiff line numberDiff line change
@@ -62,61 +62,9 @@ Locally
6262

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

65-
Docker
66-
~~~~~~
67-
68-
Alternatively, you can build and run the xblock-sdk in Docker (we are using docker compose which
69-
can be installed as explained at https://docs.docker.com/compose/install/)
70-
71-
After cloning this repository locally, go into the repository directory and build the Docker image::
72-
73-
$ make docker_build
74-
75-
or manually run
76-
77-
$ docker compose build
78-
79-
You can then run the locally-built version using the following command::
80-
81-
$ make dev.up
82-
83-
or manually run::
84-
85-
$ docker compose up -d
86-
87-
You should now be able to access the XBlock SDK environment in your browser at http://localhost:8000
88-
89-
To stop the container (without removing data) by::
90-
91-
$ make dev.stop
92-
93-
or manually run::
94-
95-
$ docker compose stop
96-
97-
Note, using::
98-
99-
$ make dev.down
100-
101-
or::
102-
103-
$ docker compose down
104-
105-
will shut down the container and delete non-persistent data.
106-
107-
You can open a bash shell in the running container by using::
108-
109-
$ make app-shell
110-
111-
or::
112-
113-
$ docker container exec -it edx.devstack.xblock-sdk bash
114-
11565
Testing
11666
~~~~~~~
11767

118-
If using Docker, all these commands need to be run inside the xblock-sdk container.
119-
12068
Testing is done via tox to test all supported versions:
12169

12270
#. Create and activate a virtualenv to work in.

docker-compose.yml

-19
This file was deleted.

0 commit comments

Comments
 (0)