refactor

- remove ci/docker step as it takes too long at 61 minutes
- remove `docker.alpine`
- add note that it might degrade

Author: Byron

.github/workflows/ci.yml

@@ -150,21 +150,6 @@ jobs:
         run: cargo +${{ matrix.rust }} install --target ${{ matrix.target }} --no-default-features --features max-pure --target-dir install-artifacts --debug --force gitoxide
         shell: msys2 {0}
 
-  docker:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-      - name: Build Docker image
-        uses: docker/build-push-action@v5
-        with:
-          context: .
-          file: ./etc/docker/Dockerfile.alpine
-          platforms: linux/amd64,linux/arm64
-          push: false
-          tags: paulbelt/gitoxide:latest
-
   lint:
     runs-on: ubuntu-latest
     steps:

README.md

@@ -62,41 +62,6 @@ Follow linked crate name for detailed status. Please note that all crates follow
 
 [semver]: https://semver.org
 
-### Pipeline Integration
-
-Some CI/CD pipelines leverage repository cloning. Below is a copy-paste-able example to build docker images for such workflows. As no official image exists (at this time), one must first be built.
-
-#### Pipeline Integration - building the base image (when speed matters)
-
-```sh
-docker build -f etc/docker/Dockerfile.alpine -t gitoxide:latest --compress . --target=pipeline
-```
-
-#### Pipeline Integration - building a smaller base image (when bits on the wire matter)
-
-```sh
-docker build -f etc/docker/Dockerfile.bookworm -t gitoxide:latest --compress . --target=pipeline
-```
-
-Once a docker image is built there are 2 options. One can replace `FROM alpine:latest` (or `FROM debian:bookworm-slim`) with `FROM gitoxide:latest`, or the resulting binaries can be copied into an existing `Dockerfile` and leveraged as a drop-in replacement for `git clone` directives.
-
-#### Pipeline Integration - minimal
-
-For example, if a `Dockerfile` currently uses something like `RUN git clone https://github.com/Byron/gitoxide`, first build the minimal image:
-
-```sh
-docker build -f etc/docker/Dockerfile.alpine -t gitoxide:latest --compress .
-```
-
-Then copy the binaries into your image and replace the `git` directive with a `gix` equivalent.
-
-```dockerfile
-COPY --from gitoxide:latest /bin/gix /usr/local/bin/
-COPY --from gitoxide:latest /bin/ein /usr/local/bin/
-
-RUN /usr/local/bin/gix clone --depth 1 https://github.com/Byron/gitoxide gitoxide
-```
-
 ### Production Grade
 
 * **Stability Tier 1**
@@ -261,6 +226,35 @@ What follows is a list of known failures.
 
 - On Fedora, `perl` needs to be installed for `OpenSSL` to build properly. This can be done with the following command:
   `dnf install perl` (see [this issue](https://github.com/Byron/gitoxide/issues/592)).
+- 
+### Using Docker
+
+Some CI/CD pipelines leverage repository cloning. Below is a copy-paste-able example to build docker images for such workflows. 
+As no official image exists (at this time), an image must first be built.
+
+#### Building the most compatible base image 
+
+```sh
+docker build -f etc/docker/Dockerfile.alpine -t gitoxide:latest --compress . --target=pipeline
+```
+
+#### Basic usage in a Pipeline
+
+For example, if a `Dockerfile` currently uses something like `RUN git clone https://github.com/Byron/gitoxide`, first build the image:
+
+```sh
+docker build -f etc/docker/Dockerfile.alpine -t gitoxide:latest --compress .
+```
+
+Then copy the binaries into your image and replace the `git` directive with a `gix` equivalent.
+
+```dockerfile
+COPY --from gitoxide:latest /bin/gix /usr/local/bin/
+COPY --from gitoxide:latest /bin/ein /usr/local/bin/
+
+RUN /usr/local/bin/gix clone --depth 1 https://github.com/Byron/gitoxide gitoxide
+```
+
 
 [releases]: https://github.com/Byron/gitoxide/releases
 [rustup]: https://rustup.rs

etc/docker/Dockerfile.alpine

@@ -1,3 +1,4 @@
+# Please note that this file is not regularly tested, and you are welcome to create PRs with fixes as needed.
 ARG GITOXIDE_VERSION=0.36.0
 
 FROM rust:alpine AS bootstrap_os