File tree 6 files changed +5
-156
lines changed
6 files changed +5
-156
lines changed Load Diff This file was deleted.
Original file line number Diff line number Diff line change @@ -4,6 +4,11 @@ Change history for XBlock SDK
4
4
5
5
These are notable changes in XBlock.
6
6
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
+
7
12
0.13.0 - 2024-08-28
8
13
-------------------
9
14
Load Diff This file was deleted.
Original file line number Diff line number Diff line change 1
1
# !/usr/bin/make -f
2
2
3
3
.PHONY : clean help quality requirements selfcheck test test-all upgrade validate
4
- .PHONY : docker_build docker_auth docker_tag docker_push
5
4
.DEFAULT_GOAL := help
6
5
7
6
define BROWSER_PYSCRIPT
@@ -95,34 +94,3 @@ validate: quality test ## run tests and quality checks
95
94
96
95
selfcheck : # # check that the Makefile is well-formed
97
96
@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} "
Original file line number Diff line number Diff line change @@ -62,61 +62,9 @@ Locally
62
62
63
63
#. Open a web browser to: http://127.0.0.1:8000
64
64
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
-
115
65
Testing
116
66
~~~~~~~
117
67
118
- If using Docker, all these commands need to be run inside the xblock-sdk container.
119
-
120
68
Testing is done via tox to test all supported versions:
121
69
122
70
#. Create and activate a virtualenv to work in.
Load Diff This file was deleted.
You can’t perform that action at this time.
0 commit comments