Skip to content

Commit eaf007b

Browse files
authored
Include changelog in docs (#2161)
* Include changelog in docs * Rename file * Fix redirect link * Fix * Rename changelog link file
1 parent 79261f1 commit eaf007b

File tree

4 files changed

+12
-1
lines changed

4 files changed

+12
-1
lines changed

.github/workflows/sphinx.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ on:
1010

1111
- "docs/**"
1212
- "README.md"
13+
- "CHANGELOG.md"
1314
push:
1415
branches:
1516
- main
@@ -18,6 +19,7 @@ on:
1819

1920
- "docs/**"
2021
- "README.md"
22+
- "CHANGELOG.md"
2123
workflow_dispatch:
2224

2325
jobs:

CHANGELOG.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# Changelog
22

3+
This changelog only contains breaking and/or significant changes manually introduced to this repository (using Pull Requests).
4+
All image manifests can be found in [the wiki](https://github.com/jupyter/docker-stacks/wiki).
5+
36
## 2024-10-09
47

58
Affected: users building a custom set of images
69

7-
- **Breaking:** Rename: `ROOT_CONTAINER`->`ROOT_IMAGE`, `BASE_CONTAINER`->`BASE_IMAGE` ([#2154](https://github.com/jupyter/docker-stacks/pull/2154), [#2155](https://github.com/jupyter/docker-stacks/pull/2155))
10+
- **Breaking:** Rename: `ROOT_CONTAINER`->`ROOT_IMAGE`, `BASE_CONTAINER`->`BASE_IMAGE` ([#2154](https://github.com/jupyter/docker-stacks/issues/2154), [#2155](https://github.com/jupyter/docker-stacks/pull/2155))

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Table of Contents
1616
using/custom-images
1717
using/troubleshooting
1818
using/faq
19+
using/changelog
1920

2021
.. toctree::
2122
:maxdepth: 2

docs/using/changelog.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
```{include} ../../CHANGELOG.md
2+
3+
```
4+
5+
<!-- markdownlint-disable-file MD041 -->

0 commit comments

Comments
 (0)