Skip to content

Commit 883b709

Browse files
pedro-psbclaude
pedro-psb
and
claude
committed
chore: refactor release workflow into reusable components
Split the release workflow into modular, reusable components: - Create release__create-commit.yml for version bumping and changelog updates - Create release__publish-pypi.yml for PyPI publishing - Create release__publish-github.yml for GitHub release creation - Create release__publish-docs.yml for Netlify documentation deployment - Update main release.yml to call these reusable workflows All workflows are in dry-run mode with actual publishing steps commented out for safe testing before enabling production deployments. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent c82bd6a commit 883b709

File tree

7 files changed

+218
-110
lines changed

7 files changed

+218
-110
lines changed

‎.github/workflows/main.yml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,8 @@ jobs:
3232

3333
build:
3434
needs: lint
35-
uses: ./.github/workflows/main__build.yml
35+
uses: ./.github/workflows/main__build-dist.yml
3636
with:
37-
python_version: "3.9"
3837
artifact_out: "dynaconf_dist"
3938

4039
tests:

.github/workflows/main__build.yml renamed to .github/workflows/main__build-dist.yml

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,6 @@ name: Build Distribution
33
on:
44
workflow_call:
55
inputs:
6-
python_version:
7-
description: "Python version to use for building"
8-
required: false
9-
type: string
10-
default: "3.9"
116
artifact_out:
127
description: "Name for the uploaded artifact"
138
required: true
@@ -21,7 +16,7 @@ jobs:
2116
- uses: actions/setup-python@v5
2217
with:
2318
# build requires the lowerbound python we support
24-
python-version: ${{ inputs.python_version }}
19+
python-version: "3.9"
2520
- name: Install uv
2621
uses: astral-sh/setup-uv@v6
2722
- name: Install build dependencies

‎.github/workflows/release.yml‎

Lines changed: 57 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -1,109 +1,64 @@
1-
name: publish-and-release
1+
name: Create Release Commit
22

33
on:
44
workflow_dispatch:
55
inputs:
6-
release:
6+
release-tag:
77
description: "Release tag (e.g. 3.2.1)"
8-
release-again:
9-
description: "Just checking."
8+
required: true
9+
type: string
1010

1111
jobs:
12-
build-and-test:
13-
name: "Build and Test distribution"
14-
runs-on: ubuntu-latest
15-
if: ${{ inputs.release == inputs.release-again }}
16-
steps:
17-
- uses: actions/checkout@v4
18-
- uses: actions/setup-python@v5
19-
with:
20-
python-version: "3.9"
21-
22-
- name: "Prepare build environment"
23-
run: |
24-
pip install --user python-minifier wheel setuptools
25-
26-
- name: "Build and Check distribution"
27-
run: |
28-
make dist
29-
.github/scripts/dist-health-check.sh
30-
31-
- name: Save dist files
32-
uses: actions/upload-artifact@v3
33-
with:
34-
name: dist-folder
35-
path: dist
36-
if-no-files-found: "error"
37-
38-
create-release-commit:
39-
name: "Create and push release commit, post-release"
40-
needs: "build-and-test"
41-
runs-on: ubuntu-latest
42-
steps:
43-
- uses: actions/checkout@v4
44-
- uses: actions/setup-python@v5
45-
with:
46-
python-version: "3.9"
47-
48-
- name: "Prepare release tools"
49-
run: |
50-
pip install --user git-changelog
51-
52-
- name: "Bump Versions, update changelog and create release-commit"
53-
run: |
54-
.github/scripts/create-release-commit.sh {{ github.event.input.release}}
55-
56-
- name: "Push commit to master"
57-
run: |
58-
echo "Pushing commit to master"
59-
git log --oneline -5
60-
git show HEAD
61-
62-
63-
pypi-publish:
64-
name: "Upload release to PyPI"
65-
needs: create-release-commit
66-
runs-on: ubuntu-latest
67-
environment:
68-
name: pypi
69-
url: https://pypi.org/p/dynaconf
70-
permissions:
71-
id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
72-
steps:
73-
- name: Get distribution
74-
uses: actions/download-artifact@v3
75-
with:
76-
name: dist-folder
77-
path: dist
78-
79-
- name: Test publish
80-
run: |
81-
tree dist
82-
83-
# - name: Publish package distributions to PyPI
84-
# uses: pypa/gh-action-pypi-publish@release/v1
85-
86-
github-release:
87-
name: Create GitHub Release
88-
needs: pypi-publish
89-
runs-on: ubuntu-latest
90-
steps:
91-
- name: Checkout
92-
uses: actions/checkout@v4
93-
94-
- name: Setup Python
95-
uses: actions/setup-python@v5
96-
97-
- name: Install git-changelog
98-
run: pip install git-changelog
99-
100-
- name: Prepare release notes
101-
run: |
102-
git-changelog --release-notes > release-notes.md
103-
echo "Release notes being used:"
104-
cat release-notes.md
105-
106-
# - name: Create GitHub release
107-
# uses: softprops/action-gh-release@v1
108-
# with:
109-
# body_path: release-notes.md
12+
# Create "VCS release"
13+
release-commit:
14+
name: "Create release commits"
15+
description: |
16+
Creates and pushes the commits:
17+
1. tagged release commit with changelog updates
18+
2. post-release commit with next version bump
19+
uses: ./.github/workflows/release__create-commit.yml
20+
with:
21+
release-tag: ${{ inputs.release-tag }}
22+
secrets: inherit
23+
24+
# Generate release artifacats
25+
build-dist:
26+
name: "Build distribution"
27+
uses: ./.github/workflows/main__build-dist.yml
28+
with:
29+
artifact_out: "dist-folder"
30+
31+
build-docs:
32+
name: "Build documentation"
33+
uses: ./.github/workflows/main__build-docs.yml
34+
with:
35+
artifact_out: "docs-site"
36+
37+
# Push to prod
38+
publish-pypi:
39+
name: "Publish to PyPI"
40+
needs: build-dist
41+
uses: ./.github/workflows/release__publish-pypi.yml
42+
with:
43+
artifact_in: "dist-folder"
44+
release-tag: ${{ inputs.release-tag }}
45+
secrets: inherit
46+
47+
publish-github:
48+
name: "Publish to GitHub"
49+
needs: publish-pypi
50+
uses: ./.github/workflows/release__publish-github.yml
51+
with:
52+
release-tag: ${{ inputs.release-tag }}
53+
secrets: inherit
54+
55+
publish-docs:
56+
name: "Publish documentation"
57+
needs:
58+
- docs-build
59+
- publish-pypi
60+
uses: ./.github/workflows/release__publish-docs.yml
61+
with:
62+
artifact_in: "docs-site"
63+
release-tag: ${{ inputs.release-tag }}
64+
secrets: inherit

‎.github/workflows/release__create-commit.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Create Release Commit
2+
3+
on:
4+
workflow_call:
5+
inputs:
6+
release-tag:
7+
description: "Release tag (e.g. 3.2.1)"
8+
required: true
9+
type: string
10+
11+
jobs:
12+
release-commit:
13+
name: "Create and push 'release' and 'post-release' commits"
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v4
17+
- uses: actions/setup-python@v5
18+
with:
19+
python-version: "3.9"
20+
21+
- name: "Prepare release tools"
22+
run: |
23+
pip install --user git-changelog
24+
25+
- name: "Bump Versions, update changelog and create release-commit"
26+
run: |
27+
.github/scripts/create-release-commit.sh ${{ inputs.release-tag }}
28+
29+
# NOTE: Commented out for dry-run mode testing
30+
# Uncomment the following step to actually push the release commit to the repository
31+
# - name: "Push commit to master"
32+
# run: |
33+
# git push origin master
34+
35+
- name: "Show release commit (dry-run mode)"
36+
run: |
37+
echo "DRY-RUN MODE: The following commit would be pushed to master:"
38+
git log --oneline -5
39+
git show HEAD

‎.github/workflows/release__publish-docs.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Deploy Documentation to Netlify
2+
3+
on:
4+
workflow_call:
5+
inputs:
6+
artifact_in:
7+
description: "Name of the artifact containing the built documentation"
8+
required: true
9+
type: string
10+
release-tag:
11+
description: "Release tag (e.g. 3.2.1)"
12+
required: true
13+
type: string
14+
15+
# https://github.com/marketplace/actions/netlify-actions#usage
16+
jobs:
17+
deploy:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- name: Download documentation
21+
uses: actions/download-artifact@v4
22+
with:
23+
name: ${{ inputs.artifact_in }}
24+
path: site
25+
26+
- name: Deploy to Netlify
27+
uses: nwtgck/actions-netlify@v3.0
28+
with:
29+
publish-dir: './site'
30+
production-branch: master
31+
github-token: ${{ secrets.GITHUB_TOKEN }}
32+
deploy-message: "Deploy from GitHub Actions"
33+
enable-pull-request-comment: false
34+
enable-commit-comment: true
35+
overwrites-pull-request-comment: true
36+
env:
37+
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
38+
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
39+
timeout-minutes: 1

‎.github/workflows/release__publish-github.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Publish GitHub Release
2+
3+
on:
4+
workflow_call:
5+
inputs:
6+
release-tag:
7+
description: "Release tag (e.g. 3.2.1)"
8+
required: true
9+
type: string
10+
11+
jobs:
12+
github-publish:
13+
name: Create GitHub Release
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@v4
18+
with:
19+
fetch-depth: 0
20+
21+
- name: Checkout release tag
22+
run: |
23+
git checkout ${{ inputs.release-tag }}
24+
25+
- name: Setup Python
26+
uses: actions/setup-python@v5
27+
28+
- name: Install git-changelog
29+
run: pip install git-changelog
30+
31+
- name: Prepare release notes
32+
run: |
33+
git-changelog --release-notes > release-notes.md
34+
echo "DRY-RUN MODE: The following release notes would be used:"
35+
cat release-notes.md
36+
37+
# NOTE: Commented out for dry-run mode testing
38+
# Uncomment the following step to actually create the GitHub release
39+
# - name: Create GitHub release
40+
# uses: softprops/action-gh-release@v1
41+
# with:
42+
# body_path: release-notes.md

‎.github/workflows/release__publish-pypi.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Publish to PyPI
2+
3+
on:
4+
workflow_call:
5+
inputs:
6+
artifact_in:
7+
description: "Name of the artifact containing the distribution"
8+
required: true
9+
type: string
10+
release-tag:
11+
description: "Release tag (e.g. 3.2.1)"
12+
required: true
13+
type: string
14+
15+
jobs:
16+
pypi-publish:
17+
name: "Upload release to PyPI"
18+
runs-on: ubuntu-latest
19+
environment:
20+
name: pypi
21+
url: https://pypi.org/p/dynaconf
22+
permissions:
23+
id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
24+
steps:
25+
- name: Get distribution
26+
uses: actions/download-artifact@v4
27+
with:
28+
name: ${{ inputs.artifact_in }}
29+
path: dist
30+
31+
- name: Show distribution contents (dry-run mode)
32+
run: |
33+
echo "DRY-RUN MODE: The following distribution would be published to PyPI:"
34+
tree dist
35+
36+
# NOTE: Commented out for dry-run mode testing
37+
# Uncomment the following step to actually publish to PyPI
38+
# - name: Publish package distributions to PyPI
39+
# uses: pypa/gh-action-pypi-publish@release/v1

0 commit comments

Comments
 (0)