GithubStar/Douyin_TikTok_Download_API
1
0
Fork 0
mirror of https://github.com/Evil0ctal/Douyin_TikTok_Download_API.git synced 2026-10-16 20:31:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: put the git tag and the image tag side by side in release notes

Browse Source 
A release note is the one place a reader meets both names for the same
build, so it is where the difference has to be visible rather than
remembered. Every release now ends with the same three-row table: the
git tag `vX.Y.Z`, the `DTK_IMAGE_TAG` for the release (`X.Y.Z`), and the
`sha-` tag for the exact build. Labelled by the variable the reader is
about to set, not by "Docker tag", because filling in .env is the actual
next action.

Not solved by publishing a `vX.Y.Z` image alias: the Docker convention
is no prefix (python:3.12, redis:8), an alias gives one image two names,
and it would not exist retroactively for 5.0.0 and 5.0.1 anyway.

`latest` and `X.Y` are named only to say not to pin them - they move
with every release, and a note that told somebody to pin `latest` would
be wrong the moment the next one ships.

While here: v5.0.1's upgrade block had lost the `COMPOSE_ENV_FILES=.env`
that v5.0.0 carried. Without it compose resolves `image:` to
`dtk-app:dev` and the tag just written into .env is ignored - measured,
not assumed. The line is back, with an inline comment so it survives the
next edit.
This commit is contained in:
Evil0ctal
2026-09-10 22:00:03 -07:00
parent 2884b6112f
commit 6bd2b5b6fe
3 changed files with 65 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/RELEASE_TEMPLATE.md
+25 -4
View File
@@ -35,7 +35,8 @@ Delete this header block before publishing.
```bash
cd /opt/dtk && git pull
# set DTK_IMAGE_TAG=X.Y.Z in .env
# set DTK_IMAGE_TAG=X.Y.Z in .env — no `v`, see the tag table at the bottom
export COMPOSE_ENV_FILES=.env # without this, `image:` ignores the root .env
docker compose -p dtk -f docker/compose.yml pull api worker downloader
docker compose -p dtk -f docker/compose.yml run --rm migrate
docker compose -p dtk -f docker/compose.yml up -d
@@ -80,7 +81,8 @@ pool, the archive, the settings and the API keys stay where they are.
```bash
cd /opt/dtk && git pull
# 在 .env 里把 DTK_IMAGE_TAG 改成 X.Y.Z
# 在 .env 里把 DTK_IMAGE_TAG 改成 X.Y.Z —— 不带 v，见文末标签表
export COMPOSE_ENV_FILES=.env # 不加这句，image: 的插值读不到根目录的 .env
docker compose -p dtk -f docker/compose.yml pull api worker downloader
docker compose -p dtk -f docker/compose.yml run --rm migrate
docker compose -p dtk -f docker/compose.yml up -d
@@ -113,6 +115,25 @@ docker compose -p dtk -f docker/compose.yml up -d
---
**Full changelog / 完整提交记录**: https://github.com/Evil0ctal/Douyin_TikTok_Download_API/compare/vPREV...vTHIS
### Tags / 标签
**Docker**: `evil0ctal/douyin_tiktok_download_api:X.Y.Z`
<!-- The sha is the 40-character commit the tag points at:
`git rev-list -n1 vX.Y.Z`. It is the tag to pin in production. -->
| | |
|---|---|
| Git tag / Git 标签 | `vX.Y.Z` |
| `DTK_IMAGE_TAG` — this release / 这个版本 | `X.Y.Z` |
| `DTK_IMAGE_TAG` — this exact build / 钉死这次构建 | `sha-<40-char commit>` |
The Docker tag drops the `v`: `docker/metadata-action` strips it when publishing,
so `:vX.Y.Z` was never pushed. One value names both published images. `latest`
and `X.Y` move with every release — pin a row above instead.
镜像标签不带 `v`：发布时 `docker/metadata-action` 会把它剥掉，`:vX.Y.Z` 从来没有被
推送过。这一个值同时决定两个已发布镜像的标签。`latest` 和 `X.Y`
会随每次发布移动，要钉死请用上面两行之一。
**Images / 镜像**: `evil0ctal/douyin_tiktok_download_api` · `evil0ctal/douyin_tiktok_download_api-downloader`
**Full changelog / 完整提交记录**: https://github.com/Evil0ctal/Douyin_TikTok_Download_API/compare/vPREV...vTHIS
.github/RELEASE_v5.0.0.md
+18 -2
View File
@@ -139,6 +139,22 @@ v4 继续可用。代码保留在 [`v4` 分支](https://github.com/Evil0ctal/Dou
---
**Full changelog / 完整提交记录**: https://github.com/Evil0ctal/Douyin_TikTok_Download_API/commits/v5.0.0
### Tags / 标签
**Docker**: `evil0ctal/douyin_tiktok_download_api:5.0.0`
| | |
|---|---|
| Git tag / Git 标签 | `v5.0.0` |
| `DTK_IMAGE_TAG` — this release / 这个版本 | `5.0.0` |
| `DTK_IMAGE_TAG` — this exact build / 钉死这次构建 | `sha-33a02ba71d3689ae9a05ccb90d6e6a9c19942067` |
The Docker tag drops the `v`: `docker/metadata-action` strips it when publishing,
so `:v5.0.0` was never pushed. One value names both published images. `latest`
and `5.0` move with every release — pin a row above instead.
镜像标签不带 `v`：发布时 `docker/metadata-action` 会把它剥掉，`:v5.0.0` 从来没有被
推送过。这一个值同时决定两个已发布镜像的标签。`latest` 和 `5.0`
会随每次发布移动，要钉死请用上面两行之一。
**Images / 镜像**: `evil0ctal/douyin_tiktok_download_api` · `evil0ctal/douyin_tiktok_download_api-downloader`
**Full changelog / 完整提交记录**: https://github.com/Evil0ctal/Douyin_TikTok_Download_API/commits/v5.0.0
.github/RELEASE_v5.0.1.md
+22 -4
View File
@@ -8,7 +8,8 @@ whole sidebar and answering 403 on most of it.
```bash
cd /opt/dtk && git pull
# set DTK_IMAGE_TAG=5.0.1 in .env
# set DTK_IMAGE_TAG=5.0.1 in .env — no `v`, see the tag table at the bottom
export COMPOSE_ENV_FILES=.env # without this, `image:` ignores the root .env
docker compose -p dtk -f docker/compose.yml pull api worker downloader
docker compose -p dtk -f docker/compose.yml run --rm migrate
docker compose -p dtk -f docker/compose.yml up -d
@@ -95,7 +96,8 @@ migrations in this release.
```bash
cd /opt/dtk && git pull
# 在 .env 里把 DTK_IMAGE_TAG 改成 5.0.1
# 在 .env 里把 DTK_IMAGE_TAG 改成 5.0.1 —— 不带 v，见文末标签表
export COMPOSE_ENV_FILES=.env # 不加这句，image: 的插值读不到根目录的 .env
docker compose -p dtk -f docker/compose.yml pull api worker downloader
docker compose -p dtk -f docker/compose.yml run --rm migrate
docker compose -p dtk -f docker/compose.yml up -d
@@ -158,6 +160,22 @@ bash install/install.zh.sh --manage
---
**Full changelog / 完整提交记录**: https://github.com/Evil0ctal/Douyin_TikTok_Download_API/compare/v5.0.0...v5.0.1
### Tags / 标签
**Docker**: `evil0ctal/douyin_tiktok_download_api:5.0.1`
| | |
|---|---|
| Git tag / Git 标签 | `v5.0.1` |
| `DTK_IMAGE_TAG` — this release / 这个版本 | `5.0.1` |
| `DTK_IMAGE_TAG` — this exact build / 钉死这次构建 | `sha-1b9478a97f89a606a7147fc1acb4461b06dc3af6` |
The Docker tag drops the `v`: `docker/metadata-action` strips it when publishing,
so `:v5.0.1` was never pushed. One value names both published images. `latest`
and `5.0` move with every release — pin a row above instead.
镜像标签不带 `v`：发布时 `docker/metadata-action` 会把它剥掉，`:v5.0.1` 从来没有被
推送过。这一个值同时决定两个已发布镜像的标签。`latest` 和 `5.0`
会随每次发布移动，要钉死请用上面两行之一。
**Images / 镜像**: `evil0ctal/douyin_tiktok_download_api` · `evil0ctal/douyin_tiktok_download_api-downloader`
**Full changelog / 完整提交记录**: https://github.com/Evil0ctal/Douyin_TikTok_Download_API/compare/v5.0.0...v5.0.1