mirrors/diun
1
0
Fork 0
mirror of https://github.com/crazy-max/diun.git synced 2025-12-21 21:33:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

Inject changelog in doc

Browse Source
This commit is contained in:
CrazyMax
2020-06-20 04:40:39 +02:00
parent f521384ee1
commit b209ab6fe1
5 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CHANGELOG.md
View File

@@ -2,7 +2,7 @@
## 3.0.0 (2020/05/27) ## 3.0.0 (2020/05/27)
> :warning: See **Migration notes** in the documentation for breaking changes. :warning: See **Migration notes** in the documentation for breaking changes.
* Add script notification (#53) * Add script notification (#53)
* Add Teams notification (#72) * Add Teams notification (#72)
@@ -66,7 +66,7 @@
## 2.0.0 (2019/12/14) ## 2.0.0 (2019/12/14)
> :warning: See **Migration notes** in the documentation for breaking changes. :warning: See **Migration notes** in the documentation for breaking changes.
* Include provider in notifications * Include provider in notifications
* Add providers documentation * Add providers documentation
@@ -121,7 +121,7 @@
## 1.0.0 (2019/07/01) ## 1.0.0 (2019/07/01)
> :warning: See **Migration notes** in the documentation for breaking changes. :warning: See **Migration notes** in the documentation for breaking changes.
* Always run on startup. Flag `--run-startup` removed. * Always run on startup. Flag `--run-startup` removed.
* Display next execution time * Display next execution time

1
Dockerfile.mkdocs
View File

@@ -7,6 +7,7 @@ RUN \
openssh \ openssh \
&& apk add --no-cache --virtual .build gcc musl-dev \ && apk add --no-cache --virtual .build gcc musl-dev \
&& pip install --no-cache-dir \ && pip install --no-cache-dir \
'markdown-include' \
'mkdocs-macros-plugin' \ 'mkdocs-macros-plugin' \
&& apk del .build gcc musl-dev \ && apk del .build gcc musl-dev \
&& rm -rf /tmp/* && rm -rf /tmp/*

1
docs/changelog.md Normal file
View File

@@ -0,0 +1 @@
{!../CHANGELOG.md!}

3
docs/get-started.md
View File

@@ -4,9 +4,6 @@
[single executable](https://github.com/crazy-max/diun/releases/latest) (and a [Docker image](install/docker.md)) [single executable](https://github.com/crazy-max/diun/releases/latest) (and a [Docker image](install/docker.md))
to receive notifications when a Docker image is updated on a Docker registry. to receive notifications when a Docker image is updated on a Docker registry.
## Purpose
The goal of this project is to provide the easiest, fastest, and most painless way of setting up a self-hosted service to handle this.
With Go, this can be done with an independent binary distribution across all platforms and architectures that Go supports. With Go, this can be done with an independent binary distribution across all platforms and architectures that Go supports.
This support includes Linux, macOS, and Windows, on architectures like amd64, i386, ARM, PowerPC, and others. This support includes Linux, macOS, and Windows, on architectures like amd64, i386, ARM, PowerPC, and others.

3
mkdocs.yml
View File

@@ -82,6 +82,7 @@ nav:
- Kubernetes: providers/kubernetes.md - Kubernetes: providers/kubernetes.md
- Swarm: providers/swarm.md - Swarm: providers/swarm.md
- FAQ: faq.md - FAQ: faq.md
- Changelog: changelog.md
- Migration: - Migration:
- Diun v2 to v3: migration/v2-to-v3.md - Diun v2 to v3: migration/v2-to-v3.md
- Diun v1 to v2: migration/v1-to-v2.md - Diun v1 to v2: migration/v1-to-v2.md
@@ -94,6 +95,8 @@ markdown_extensions:
- admonition - admonition
- codehilite - codehilite
- footnotes - footnotes
- markdown_include.include:
base_path: docs
- meta - meta
- pymdownx.details - pymdownx.details
- pymdownx.tabbed - pymdownx.tabbed