Skip to content

Commit f003f02

Browse files
brandonpaytonbrandonpayton
authored
Fix changelog workflow and backfill changelog entries from recent versions (#83)
## Motivation for the change, related issues Our changelog workflow is currently broken because it is missing extra GitHub token secrets. If we add these secrets, we will have to update them occasionally. I think we may be able to do without and would like to try that. In addition, we need to backfill changelog entries while omitting links to PRs (since we cannot link to our private PRs). ## Implementation details This PR: - Updates our changelog update workflow to persist credentials in the local git config and attempts to follow the example of pushing a commit after actions/checkout: https://github.com/actions/checkout?tab=readme-ov-file#push-a-commit-using-the-built-in-token - Omits PR links from new changelog entries unless they point to github.com/WordPress/wordpress-playground - Backfills changelog entries for v1.0.25 to v1.0.29. ## Testing Instructions (or ideally a Blueprint) - Temporarily disable protections on running the workflow - Make the workflow target the PR branch - Manually run the workflow and see if it commits a changelog update to the PR branch - If successful, remove the changelog commit from the PR branch - Re-enable protections - Re-enable checking out trunk only - Merge
1 parent bd40fb6 commit f003f02

File tree

5 files changed

+288
-32
lines changed

5 files changed

+288
-32
lines changed

‎.github/workflows/update-changelog.yml

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88
required: true
99
default: 'current'
1010
workflow_run:
11-
workflows: [Release NPM packages]
11+
workflows: [Release NPM packages, Release self-hosted packages]
1212
types:
1313
- completed
1414

@@ -32,16 +32,18 @@ jobs:
3232
name: wordpress-assets
3333
env:
3434
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
35+
GITHUB_OWNER: ${{ github.repository_owner }}
36+
GITHUB_REPO: ${{ github.repository }}
3537
steps:
38+
- name: 'Prune owner from repo name'
39+
run: |
40+
echo "GITHUB_REPO=${GITHUB_REPO#$GITHUB_OWNER/}" >> $GITHUB_ENV
3641
- uses: actions/checkout@v4
3742
with:
38-
submodules: true
43+
submodules: recursive
3944
ref: trunk
4045
clean: true
41-
persist-credentials: false
42-
- name: Fetch trunk
43-
shell: bash
44-
run: git fetch origin trunk --depth=1 --recurse-submodules
46+
persist-credentials: true
4547
- name: 'Install bun (for the changelog)'
4648
run: |
4749
curl -fsSL https://bun.sh/install | bash
@@ -59,13 +61,12 @@ jobs:
5961
run: |
6062
git config --global user.name "deployment_bot"
6163
git config --global user.email "[email protected]"
62-
git remote set-url origin https://${{ secrets.GH_ACTOR }}:${{ secrets.GH_TOKEN }}@github.com/${{ github.repository }}
6364
if [[ -n $(git status --porcelain CHANGELOG.md) ]]; then
6465
git commit -m "chore: update changelog" \
6566
CHANGELOG.md \
6667
packages/docs/site/docs/*changelog*.md
67-
git pull origin trunk --rebase
68-
git push origin trunk
68+
git pull --depth=1 --rebase origin "$(git branch --show-current)"
69+
git push
6970
else
7071
echo "No changes in CHANGELOG.md. Skipping commit and push."
7172
fi

‎CHANGELOG.md

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,119 @@ All notable changes to this project are documented in this file by a CI job
44
that runs on every NPM release. The file follows the [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
55
format.
66

7+
## [v1.0.29] (2025-03-11)
8+
9+
### Various
10+
11+
- Blueprint bundles.
12+
- CORS Proxy: fetch() with credentials: "include".
13+
- Exif support for PHP-wasm.
14+
- Remove Data Liberation PHP modules.
15+
- Stop suppressing 64bit integer PHP warnings as 64bit longs are now suppoted.
16+
- [Blueprints] setSiteLanguage fetch translation package URL from WP.org.
17+
- [Website] Drop the static <link rel="manifest"> tag and generate one in JavaScript instead.
18+
19+
### Contributors
20+
21+
The following contributors merged PRs in this release:
22+
23+
@adamziel @bgrgicak
24+
25+
## [v1.0.28] (2025-03-05)
26+
27+
### Various
28+
29+
- 64bit integer support, drop PHP 7.0 and 7.1 support.
30+
- FS Journal: Handle renaming OPFS files via delete + create (instead of file.move()).
31+
- GitHub: Cache node_modules per arch to avoid nx error.
32+
- Merge from public Playground repo.
33+
- OPFS site creation: Use the same "is this directory a site?" check as the site list.
34+
- Stop adding source maps to offline assets list.
35+
- Support mobile access to private Playground instance.
36+
- TLS->HTTP Proxy: Support outbound request body.
37+
- TLS: Only use the server_name extension during server hello.
38+
- Website: Blueprints as PWAs with a dynamic manifest.json file.
39+
- Website: Preserve the `mode` query arg when opening OPFS site.
40+
41+
### Contributors
42+
43+
The following contributors merged PRs in this release:
44+
45+
@adamziel @brandonpayton
46+
47+
## [v1.0.27] (2025-02-25)
48+
49+
### Bug Fixes
50+
51+
- Fix php-wasm build error for WITH_SOURCEMAPS=yes.
52+
- Fix php-wasm source map base.
53+
- Fix private website deployment workflow.
54+
- Fix up private website deployment workflow after initial commit.
55+
56+
### Various
57+
58+
- Add WITH_DEBUG option for building php-wasm with DWARF debug info.
59+
- Add `janjakes` to GitHub workflows actors.
60+
- Add a dedicated workflow for deploying private playground.
61+
- Add remote data blocks to the allowlist.
62+
- Allow ashfame to run self-hosted package release workflow.
63+
- Allow deploying custom supported domains for CORS proxy.
64+
- CORS proxy: Make allowed origins configurable.
65+
- Make further fixes for unreliable end-to-end tests.
66+
- Move DNS polyfills to a PHP extension and add missing constants.
67+
- New playground CLI function interface.
68+
- Replace some hardcoded refs to playground.wordpress.net web app.
69+
- Restore safety condition for CORS proxy deployment workflow.
70+
- Revert "Add the launch browser flag to CLI".
71+
- Revert "Support file URL resources in command line environment".
72+
- Schedule private deployment and use private environment.
73+
- Stop assuming CLI stdout is a TTY write stream.
74+
- Store WordPress site cookies in the browser instead of a custom Cookie Store.
75+
- Support file URL resources in command line environment.
76+
- Switch to relative paths in app manifest.
77+
- Switch to runner with more CPU and RAM.
78+
- Treat zip files as zip files regardless of file name.
79+
- Try more Playwright workers since we have a runner with more resources.
80+
- Update private Playground instance to use dedicated CORS proxy.
81+
- Use rsync instead of scp in website deploy workflow.
82+
- Use specified SQLite version also for PHP < 7.4.
83+
84+
### Contributors
85+
86+
The following contributors merged PRs in this release:
87+
88+
@adamziel @bgrgicak @brandonpayton @ingeniumed @JanJakes @zaerl
89+
90+
## [v1.0.26] (2025-02-04)
91+
92+
### Bug Fixes
93+
94+
- Fix workflow for deploying self-hosted packages.
95+
96+
### Various
97+
98+
- Add the launch browser flag to CLI.
99+
- [Fix] Zip spec compliance for exported backup file.
100+
101+
### Contributors
102+
103+
The following contributors merged PRs in this release:
104+
105+
@ashfame @brandonpayton @zaerl
106+
107+
## [v1.0.25] (2025-02-04)
108+
109+
### Various
110+
111+
- Add missing node external to Playground CLI.
112+
- Add self-hosted package publishing.
113+
114+
### Contributors
115+
116+
The following contributors merged PRs in this release:
117+
118+
@brandonpayton
119+
7120
## [v1.0.24] (2025-02-03)
8121

9122
## [v1.0.23] (2025-01-27)

‎packages/docs/site/docs/main/changelog.md

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,119 @@ All notable changes to this project are documented in this file by a CI job
99
that runs on every NPM release. The file follows the [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
1010
format.
1111

12+
## [v1.0.29] (2025-03-11)
13+
14+
### Various
15+
16+
- Blueprint bundles.
17+
- CORS Proxy: fetch() with credentials: "include".
18+
- Exif support for PHP-wasm.
19+
- Remove Data Liberation PHP modules.
20+
- Stop suppressing 64bit integer PHP warnings as 64bit longs are now suppoted.
21+
- [Blueprints] setSiteLanguage fetch translation package URL from WP.org.
22+
- [Website] Drop the static &lt;link rel="manifest"&gt; tag and generate one in JavaScript instead.
23+
24+
### Contributors
25+
26+
The following contributors merged PRs in this release:
27+
28+
@adamziel @bgrgicak
29+
30+
## [v1.0.28] (2025-03-05)
31+
32+
### Various
33+
34+
- 64bit integer support, drop PHP 7.0 and 7.1 support.
35+
- FS Journal: Handle renaming OPFS files via delete + create (instead of file.move()).
36+
- GitHub: Cache node_modules per arch to avoid nx error.
37+
- Merge from public Playground repo.
38+
- OPFS site creation: Use the same "is this directory a site?" check as the site list.
39+
- Stop adding source maps to offline assets list.
40+
- Support mobile access to private Playground instance.
41+
- TLS->HTTP Proxy: Support outbound request body.
42+
- TLS: Only use the server_name extension during server hello.
43+
- Website: Blueprints as PWAs with a dynamic manifest.json file.
44+
- Website: Preserve the `mode` query arg when opening OPFS site.
45+
46+
### Contributors
47+
48+
The following contributors merged PRs in this release:
49+
50+
@adamziel @brandonpayton
51+
52+
## [v1.0.27] (2025-02-25)
53+
54+
### Bug Fixes
55+
56+
- Fix php-wasm build error for WITH_SOURCEMAPS=yes.
57+
- Fix php-wasm source map base.
58+
- Fix private website deployment workflow.
59+
- Fix up private website deployment workflow after initial commit.
60+
61+
### Various
62+
63+
- Add WITH_DEBUG option for building php-wasm with DWARF debug info.
64+
- Add `janjakes` to GitHub workflows actors.
65+
- Add a dedicated workflow for deploying private playground.
66+
- Add remote data blocks to the allowlist.
67+
- Allow ashfame to run self-hosted package release workflow.
68+
- Allow deploying custom supported domains for CORS proxy.
69+
- CORS proxy: Make allowed origins configurable.
70+
- Make further fixes for unreliable end-to-end tests.
71+
- Move DNS polyfills to a PHP extension and add missing constants.
72+
- New playground CLI function interface.
73+
- Replace some hardcoded refs to playground.wordpress.net web app.
74+
- Restore safety condition for CORS proxy deployment workflow.
75+
- Revert "Add the launch browser flag to CLI".
76+
- Revert "Support file URL resources in command line environment".
77+
- Schedule private deployment and use private environment.
78+
- Stop assuming CLI stdout is a TTY write stream.
79+
- Store WordPress site cookies in the browser instead of a custom Cookie Store.
80+
- Support file URL resources in command line environment.
81+
- Switch to relative paths in app manifest.
82+
- Switch to runner with more CPU and RAM.
83+
- Treat zip files as zip files regardless of file name.
84+
- Try more Playwright workers since we have a runner with more resources.
85+
- Update private Playground instance to use dedicated CORS proxy.
86+
- Use rsync instead of scp in website deploy workflow.
87+
- Use specified SQLite version also for PHP < 7.4.
88+
89+
### Contributors
90+
91+
The following contributors merged PRs in this release:
92+
93+
@adamziel @bgrgicak @brandonpayton @ingeniumed @JanJakes @zaerl
94+
95+
## [v1.0.26] (2025-02-04)
96+
97+
### Bug Fixes
98+
99+
- Fix workflow for deploying self-hosted packages.
100+
101+
### Various
102+
103+
- Add the launch browser flag to CLI.
104+
- [Fix] Zip spec compliance for exported backup file.
105+
106+
### Contributors
107+
108+
The following contributors merged PRs in this release:
109+
110+
@ashfame @brandonpayton @zaerl
111+
112+
## [v1.0.25] (2025-02-04)
113+
114+
### Various
115+
116+
- Add missing node external to Playground CLI.
117+
- Add self-hosted package publishing.
118+
119+
### Contributors
120+
121+
The following contributors merged PRs in this release:
122+
123+
@brandonpayton
124+
12125
## [v1.0.24] (2025-02-03)
13126

14127
## [v1.0.23] (2025-01-27)

‎packages/meta/bin/update-changelog.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ type VersionDetails = {
4747
};
4848

4949
const newChanges = await getReleaseChangelog({
50+
owner: process.env.GITHUB_OWNER,
51+
repo: process.env.GITHUB_REPO,
5052
token: process.env.GITHUB_TOKEN,
5153
version,
5254
});

0 commit comments

Comments
 (0)