diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml deleted file mode 100644 index a826746f..00000000 --- a/.github/workflows/docker-publish.yml +++ /dev/null @@ -1,20 +0,0 @@ -name: Push Docker Images - -on: - push: - branches: - - master -jobs: - push: - runs-on: ubuntu-latest - if: github.event_name == 'push' - - steps: - - name: Checkout - uses: actions/checkout@v4 - - - name: Build and Push docker image - env: - DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }} - DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }} - run : make docker_push diff --git a/CHANGELOG.rst b/CHANGELOG.rst index de07d7e8..994362e4 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -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 ------------------- diff --git a/Dockerfile b/Dockerfile deleted file mode 100644 index 4de8c38f..00000000 --- a/Dockerfile +++ /dev/null @@ -1,33 +0,0 @@ -FROM ubuntu:latest - -RUN apt-get update && apt-get install -y \ - gettext \ - zlib1g-dev \ - libjpeg62-dev \ - libxslt1-dev \ - python3.12 \ - python3.12-dev \ - python3.12-venv \ - curl \ - make \ - && apt-get clean \ - && rm -rf /var/lib/apt/lists/* - -COPY . /usr/local/src/xblock-sdk -WORKDIR /usr/local/src/xblock-sdk - -ENV VIRTUAL_ENV=/venvs/xblock-sdk -RUN python3.12 -m venv $VIRTUAL_ENV -ENV PATH="$VIRTUAL_ENV/bin:$PATH" - -RUN curl -sL https://deb.nodesource.com/setup_22.x -o /tmp/nodejs-setup && \ - bash /tmp/nodejs-setup && \ - rm /tmp/nodejs-setup && \ - apt-get install -y nodejs - -RUN pip install --upgrade pip setuptools -RUN make install - -EXPOSE 8000 - -ENTRYPOINT ["bash", "-c", "python manage.py migrate && exec python manage.py runserver 0.0.0.0:8000"] diff --git a/Makefile b/Makefile index ff102104..dd9dc9cf 100755 --- a/Makefile +++ b/Makefile @@ -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 @@ -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}" diff --git a/README.rst b/README.rst index 0d6afb31..bf26b8f4 100644 --- a/README.rst +++ b/README.rst @@ -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. - Testing is done via tox to test all supported versions: #. Create and activate a virtualenv to work in. diff --git a/docker-compose.yml b/docker-compose.yml deleted file mode 100644 index 063328ee..00000000 --- a/docker-compose.yml +++ /dev/null @@ -1,19 +0,0 @@ -services: - xblock_sdk: - image: openedx/xblock-sdk - container_name: edx.devstack.xblock-sdk - - build: . - - volumes: - # Provide a persistant location for the SQLite database - - xblock-var:/usr/local/src/xblock-sdk/var - - hostname: localhost - ports: - - "8000:8000" - -# Persistant storage volumes: -volumes: - # For the SQLite database - xblock-var: