Skip to content

Commit dac52a3

Browse files
committed
Merge branch 'main' into python3.13
2 parents 888b1b5 + 9d4d382 commit dac52a3

File tree

88 files changed

+426
-418
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+426
-418
lines changed

.github/workflows/docker-build-test-upload.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ jobs:
8181
python3 -m tagging.apps.write_tags_file
8282
--registry ${{ env.REGISTRY }}
8383
--owner ${{ env.OWNER }}
84-
--short-image-name ${{ inputs.image }}
84+
--image ${{ inputs.image }}
8585
--variant ${{ inputs.variant }}
8686
--tags-dir /tmp/jupyter/tags/
8787
shell: bash
@@ -97,7 +97,7 @@ jobs:
9797
python3 -m tagging.apps.write_manifest
9898
--registry ${{ env.REGISTRY }}
9999
--owner ${{ env.OWNER }}
100-
--short-image-name ${{ inputs.image }}
100+
--image ${{ inputs.image }}
101101
--variant ${{ inputs.variant }}
102102
--hist-lines-dir /tmp/jupyter/hist_lines/
103103
--manifests-dir /tmp/jupyter/manifests/
@@ -133,5 +133,5 @@ jobs:
133133
python3 -m tests.run_tests
134134
--registry ${{ env.REGISTRY }}
135135
--owner ${{ env.OWNER }}
136-
--short-image-name ${{ inputs.image }}
136+
--image ${{ inputs.image }}
137137
shell: bash

.github/workflows/docker-merge-tags.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ jobs:
6969
if: env.PUSH_TO_REGISTRY == 'true'
7070
run: >
7171
python3 -m tagging.apps.merge_tags
72-
--short-image-name ${{ inputs.image }}
72+
--image ${{ inputs.image }}
7373
--variant ${{ inputs.variant }}
7474
--tags-dir /tmp/jupyter/tags/
7575
shell: bash

.github/workflows/docker-tag-push.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ jobs:
6565
python3 -m tagging.apps.apply_tags
6666
--registry ${{ env.REGISTRY }}
6767
--owner ${{ env.OWNER }}
68-
--short-image-name ${{ inputs.image }}
68+
--image ${{ inputs.image }}
6969
--variant ${{ inputs.variant }}
7070
--platform ${{ inputs.platform }}
7171
--tags-dir /tmp/jupyter/tags/

.github/workflows/docker.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -523,8 +523,6 @@ jobs:
523523
uses: ./.github/workflows/docker-wiki-update.yml
524524
needs: [aarch64-images-tag-push-fast, x86_64-images-tag-push-fast]
525525
if: contains(github.event.pull_request.title, '[FAST_BUILD]')
526-
permissions:
527-
contents: write
528526

529527
contributed-recipes:
530528
uses: ./.github/workflows/contributed-recipes.yml

.github/workflows/pre-commit.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@ on:
77
- main
88
workflow_dispatch:
99

10-
permissions:
11-
contents: read
12-
1310
jobs:
1411
run-hooks:
1512
runs-on: ubuntu-24.04

.github/workflows/sphinx.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,8 @@ on:
2525
jobs:
2626
build-docs:
2727
runs-on: ubuntu-24.04
28-
timeout-minutes: 5
28+
timeout-minutes: 10
2929
if: github.repository_owner == 'jupyter' || github.repository_owner == 'mathbunnyru' || github.event_name != 'schedule'
30-
permissions:
31-
contents: write
3230

3331
steps:
3432
- name: Checkout Repo ⚡️

Makefile

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ build/%: ROOT_IMAGE?=ubuntu:24.04
4141
build/%: PYTHON_VERSION?=3.13
4242
build/%: ## build the latest image for a stack using the system's architecture
4343
docker build $(DOCKER_BUILD_ARGS) --rm --force-rm \
44-
--tag "$(REGISTRY)/$(OWNER)/$(notdir $@):latest" \
44+
--tag "$(REGISTRY)/$(OWNER)/$(notdir $@)" \
4545
"./images/$(notdir $@)" \
4646
--build-arg REGISTRY="$(REGISTRY)" \
4747
--build-arg OWNER="$(OWNER)" \
@@ -82,21 +82,21 @@ hook/%: ## run post-build hooks for an image
8282
python3 -m tagging.apps.write_tags_file \
8383
--registry "$(REGISTRY)" \
8484
--owner "$(OWNER)" \
85-
--short-image-name "$(notdir $@)" \
85+
--image "$(notdir $@)" \
8686
--variant "$(VARIANT)" \
8787
--tags-dir /tmp/jupyter/tags/
8888
python3 -m tagging.apps.write_manifest \
8989
--registry "$(REGISTRY)" \
9090
--owner "$(OWNER)" \
91-
--short-image-name "$(notdir $@)" \
91+
--image "$(notdir $@)" \
9292
--variant "$(VARIANT)" \
9393
--hist-lines-dir /tmp/jupyter/hist_lines/ \
9494
--manifests-dir /tmp/jupyter/manifests/ \
9595
--repository "$(REPOSITORY)"
9696
python3 -m tagging.apps.apply_tags \
9797
--registry "$(REGISTRY)" \
9898
--owner "$(OWNER)" \
99-
--short-image-name "$(notdir $@)" \
99+
--image "$(notdir $@)" \
100100
--variant "$(VARIANT)" \
101101
--platform "$(shell uname -m)" \
102102
--tags-dir /tmp/jupyter/tags/
@@ -139,5 +139,5 @@ test/%: ## run tests against a stack
139139
python3 -m tests.run_tests \
140140
--registry "$(REGISTRY)" \
141141
--owner "$(OWNER)" \
142-
--short-image-name "$(notdir $@)"
142+
--image "$(notdir $@)"
143143
test-all: $(foreach I, $(ALL_IMAGES), test/$(I)) ## test all stacks

docs/contributing/tests.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ We greatly appreciate Pull Requests that extend the automated tests that vet the
44

55
## How the Tests Work
66

7-
A [GitHub Action workflow](https://github.com/jupyter/docker-stacks/blob/main/.github/workflows/docker.yml)
7+
A [GitHub Action workflow](https://github.com/jupyter/docker-stacks/blob/main/.github/workflows/docker-build-test-upload.yml)
88
runs tests against pull requests submitted to the `jupyter/docker-stacks` repository.
99

1010
We use the `pytest` module to run tests on the image.
1111
`conftest.py` and `pytest.ini` in the `tests` folder define the environment in which tests are run.
1212
More info on `pytest` can be found [here](https://docs.pytest.org/en/latest/contents.html).
1313

14-
The actual image-specific test files are located in folders like `tests/<somestack>/` (e.g., `tests/docker-stacks-foundation/`, `tests/minimal-notebook/`, etc.).
14+
The actual image-specific test files are located in folders like `tests/by_image/<somestack>/` (e.g., `tests/by_image/docker-stacks-foundation/`, etc.).
1515

1616
```{note}
17-
If your test is located in `tests/<somestack>/`, it will be run against the `jupyter/<somestack>` image and against all the [images inherited from this image](https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html#image-relationships.
17+
If your test is located in `tests/by_image/<somestack>/`, it will be run against the `jupyter/<somestack>` image and against all the [images inherited from this image](../using/selecting.md#image-relationships).
1818
```
1919

2020
Many tests make use of global [pytest fixtures](https://docs.pytest.org/en/latest/reference/fixtures.html)
@@ -23,15 +23,15 @@ defined in the [conftest.py](https://github.com/jupyter/docker-stacks/blob/main/
2323
## Unit tests
2424

2525
You can add a unit test if you want to run a Python script in one of our images.
26-
You should create a `tests/<somestack>/units/` directory, if it doesn't already exist, and put your file there.
26+
You should create a `tests/by_image/<somestack>/units/` directory, if it doesn't already exist, and put your file there.
2727
Files in this folder will be executed in the container when tests are run.
28-
You can see an [TensorFlow package example here](https://github.com/jupyter/docker-stacks/blob/HEAD/tests/tensorflow-notebook/units/unit_tensorflow.py).
28+
You can see an [TensorFlow package example here](https://github.com/jupyter/docker-stacks/blob/HEAD/tests/by_image/tensorflow-notebook/units/unit_tensorflow.py).
2929

3030
## Contributing New Tests
3131

3232
Please follow the process below to add new tests:
3333

34-
1. Add your test code to one of the modules in the `tests/<somestack>/` directory or create a new module.
34+
1. Add your test code to one of the modules in the `tests/by_image/<somestack>/` directory or create a new module.
3535
2. Build one or more images you intend to test and run the tests locally.
3636
If you use `make`, call:
3737

docs/maintaining/tagging.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,18 +69,14 @@ So, the `tag_value(container)` method gets a docker container as an input and re
6969

7070
### Manifest
7171

72-
`ManifestHeader` is a build manifest header.
73-
It contains the following sections: `Build timestamp`, `Docker image size`, and `Git commit` info.
74-
75-
All the other manifest classes are inherited from `ManifestInterface`:
72+
All manifest classes except `BuildInfo` are inherited from `ManifestInterface`
73+
and `markdown_piece(container)` method returns a piece of the build manifest.
7674

7775
```{literalinclude} ../../tagging/manifests/manifest_interface.py
7876
:language: py
7977
:start-at: class ManifestInterface
8078
```
8179

82-
- The `markdown_piece(container)` method returns a piece of markdown file to be used as a part of the build manifest.
83-
8480
`AptPackagesManifest` example:
8581

8682
```{literalinclude} ../../tagging/manifests/apt_packages.py

docs/using/custom-images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This section describes how to build a custom set of images.
44
It may be helpful if you need to change the Ubuntu or Python version, or to make a significant change to the build process itself.
55

66
This project only builds one set of images at a time.
7-
If you want to use older images, take a look [here](https://jupyter-docker-stacks.readthedocs.io/en/latest/#using-old-images).
7+
If you want to use older images, take a look [here](../index.rst/#using-old-images).
88

99
## Automating your build using template cookiecutter project
1010

0 commit comments

Comments
 (0)