keith/Projects-Portfolio
1
0
Fork 0
forked from Solo-Web-Works/Projects-Portfolio
Code Pull Requests Activity

Point old 'How to Zip' section to automated workflow

Browse Source
This commit is contained in:
Keith Solomon
2026-08-11 07:00:44 -05:00
parent b4b6158f2d
commit 1595327a80
1 changed files with 3 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -12
View File
@@ -127,8 +127,8 @@ Releases are automated via GitHub Actions. To cut a new release:
1. Bump `PROJECTS_PORTFOLIO_VERSION` and the plugin header `Version:` in `projects-portfolio.php`.
2. Commit and push to `main`.
3. Tag the release commit: `git tag -a v1.1.0 -m "v1.1.0 — short summary"`.
4. Push the tag: `git push origin v1.1.0`.
3. Tag the release commit: `git tag -a v1.1.1 -m "v1.1.1 — short summary"`.
4. Push the tag: `git push origin v1.1.1`.
The `.github/workflows/release.yml` workflow runs and:
@@ -140,16 +140,7 @@ Dev-only paths (`composer.json`, `composer.lock`, `vendor/`, `tests/`, `plans/`,
## How to Zip the Plugin for GitHub Releases
When attaching the plugin to a GitHub release:
1. Zip **only the contents of the plugin folder**, not the parent folder.
2. Ensure `projects-portfolio.php` and `/includes`, `/admin`, `/templates`, `/assets` are at the root level of the ZIP.
3. Name the ZIP clearly (e.g. `projects-portfolio-1.0.0.zip`).
4. Go to your GitHub repo → **Releases** → **New Release**.
5. Tag the release with the version number (e.g., `1.0.0`).
6. Upload your correctly structured ZIP as a release asset.
Your users will be redirected to this file when they use the `/download/` endpoint.
This is now automated. See [Building a Release](#building-a-release) above — pushing a `v*` tag triggers `.github/workflows/release.yml` which builds and publishes the zip.
## REST API Endpoints