-
Notifications
You must be signed in to change notification settings - Fork 7
Add self-hosted changelog with automated version updates #5241
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| name: Update Self-Hosted Changelog | ||
|
|
||
| on: | ||
| schedule: | ||
| - cron: "0 * * * *" | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| update-self-hosted-changelog: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v5 | ||
| with: | ||
| ref: main | ||
| - name: Sync self-hosted releases from fern-platform | ||
| env: | ||
| GH_TOKEN: ${{ secrets.FERN_GITHUB_TOKEN }} | ||
| run: | | ||
| set -euo pipefail | ||
| DIR="fern/products/docs/pages/self-hosted/changelog" | ||
| mkdir -p "$DIR" | ||
|
|
||
| gh api -H "Accept: application/vnd.github+json" \ | ||
| "repos/fern-api/fern-platform/releases?per_page=50" \ | ||
| --jq '.[] | select(.tag_name | startswith("docs@")) | "\(.tag_name)\t\(.published_at)"' \ | ||
| | sort -k2 \ | ||
| > /tmp/releases.tsv | ||
|
|
||
| while IFS=$'\t' read -r tag published; do | ||
| version="${tag#docs@}" | ||
| date="${published%%T*}" | ||
| file="$DIR/$date.mdx" | ||
| version_escaped="${version//./\\.}" | ||
|
|
||
| if grep -rqE "^### v${version_escaped}$" "$DIR" 2>/dev/null; then | ||
| continue | ||
| fi | ||
|
|
||
| if [ -s "$file" ]; then | ||
| printf '\n### v%s\n\n```dockerfile\nFROM fernenterprise/fern-self-hosted:%s\n```\n' "$version" "$version" >> "$file" | ||
| else | ||
| printf '### v%s\n\n```dockerfile\nFROM fernenterprise/fern-self-hosted:%s\n```\n' "$version" "$version" > "$file" | ||
| fi | ||
| done < /tmp/releases.tsv | ||
| - name: create PR | ||
| id: cpr | ||
| uses: peter-evans/create-pull-request@v8 | ||
| with: | ||
| commit-message: "update self-hosted changelog from fern-platform releases" | ||
| title: "Update self-hosted changelog" | ||
| branch: update-self-hosted-changelog | ||
| base: main | ||
| delete-branch: true | ||
| - name: Enable Pull Request Automerge | ||
| if: steps.cpr.outputs.pull-request-operation == 'created' | ||
| uses: peter-evans/enable-pull-request-automerge@v3 | ||
| with: | ||
| pull-request-number: ${{ steps.cpr.outputs.pull-request-number }} | ||
| merge-method: squash | ||
| - name: Approving PR | ||
| if: steps.cpr.outputs.pull-request-operation == 'created' | ||
| env: | ||
| GH_TOKEN: ${{ secrets.FERN_GITHUB_TOKEN }} | ||
| run: | | ||
| echo "Approving PR" | ||
| gh pr review ${{ steps.cpr.outputs.pull-request-number }} --approve |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| ### v0.114.1 | ||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.1 | ||
| ``` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| ### v0.114.2 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.2 | ||
| ``` | ||
|
|
||
| ### v0.114.3 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.3 | ||
| ``` | ||
|
|
||
| ### v0.114.4 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.4 | ||
| ``` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| ### v0.114.5 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.5 | ||
| ``` | ||
|
|
||
| ### v0.114.6 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.6 | ||
| ``` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| ### v0.114.7 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.7 | ||
| ``` | ||
|
|
||
| ### v0.114.8 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.8 | ||
| ``` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| ### v0.114.9 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.9 | ||
| ``` | ||
|
|
||
| ### v0.114.10 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.10 | ||
| ``` | ||
|
|
||
| ### v0.114.11 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.11 | ||
| ``` | ||
|
|
||
| ### v0.114.12 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.12 | ||
| ``` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| ### v0.114.13 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.13 | ||
| ``` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| ### v0.114.14 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.14 | ||
| ``` | ||
|
|
||
| ### v0.114.15 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.15 | ||
| ``` | ||
|
|
||
| ### v0.114.16 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.16 | ||
| ``` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| ### v0.114.17 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.17 | ||
| ``` | ||
|
|
||
| ### v0.114.18 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.18 | ||
| ``` | ||
|
|
||
| ### v0.114.19 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.19 | ||
| ``` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| ### v0.114.20 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.20 | ||
| ``` | ||
|
|
||
| ### v0.114.21 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ```dockerfile | ||
| FROM fernenterprise/fern-self-hosted:0.114.21 | ||
| ``` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| Release history for the Fern self-hosted Docker image. Each entry shows the `FROM` line for that release. | ||
|
|
||
| To upgrade: | ||
|
|
||
| - On `:latest` — rebuild and redeploy your image to pick up the new base. | ||
| - Pinning a version — copy the `FROM` line from the release below into your Dockerfile, then rebuild and redeploy. | ||
|
|
||
| See the [self-hosted setup guide](/learn/docs/self-hosted/set-up) for the full flow. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -79,6 +79,10 @@ RUN fern-generate | |
| `fern-generate` is a command available inside the Docker image that processes your documentation at build time, enabling faster container startup, air-gapped deployment, and a smaller attack surface. It's not a command you run on your host machine. You can alternatively [defer generation to runtime](#runtime-generation). | ||
| </Info> | ||
|
|
||
| <Tip> | ||
| See [recent releases](/learn/docs/self-hosted/releases) to pin to a specific version instead of `:latest`. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
| </Tip> | ||
|
|
||
| </Step> | ||
| <Step title="Build your Docker image"> | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'v0.114.1' should use sentence-style capitalization.