You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-9Lines changed: 13 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,8 +16,9 @@ This project provides PowerShell packages and GitHub Actions to build PHP and it
16
16
-[PHP Version Support](#php-version-support)
17
17
-[Release](#release)
18
18
-[Inputs](#inputs-3)
19
-
-[Example workflow for non-immutable releases](#example-workflow-for-non-immutable-releases)
20
-
-[Example workflow for immutable releases](#example-workflow-for-immutable-releases)
19
+
-[Examples](#examples)
20
+
-[Workflow for releases](#workflow-for-releases)
21
+
-[Workflow for tags](#workflow-for-tags)
21
22
22
23
-[Local Setup](#local-setup)
23
24
-[PHP](#php)
@@ -185,11 +186,14 @@ Upload the artifacts to a release.
185
186
- `token` (optional): The GitHub token to authenticate with. Defaults to `GITHUB_TOKEN` secret.
186
187
- `draft` (optional): Whether to create a draft release if the release does not exist. Defaults to `false`.
187
188
188
-
#### Example workflow for non-immutable releases
189
189
190
-
Follow this if you are creating the release, and they are not immutable (This is the default).
190
+
### Examples
191
191
192
-
For non-immutable releases, you can publish them, and the workflow will upload the extension builds to the release.
192
+
#### Workflow for releases
193
+
194
+
Follow this if you are creating the release for publishing new versions, and they are not immutable (This is the default). For creating immutable releases follow the [workflow for tags](#workflow-for-tags).
195
+
196
+
After you create the release, the following workflow will build and upload the extension builds to the release.
193
197
194
198
```yaml
195
199
name: Build extension
@@ -252,13 +256,13 @@ jobs:
252
256
token: ${{ secrets.GITHUB_TOKEN }}
253
257
```
254
258
255
-
#### Example workflow for immutable releases
259
+
#### Workflow for tags
256
260
257
-
Follow this if you are using immutable releases.
261
+
Follow this workflow if you are using tags to release new versions.
258
262
259
-
For immutable releases, please do not create a new release using the GitHub UI, you can push a new tag, and the workflow will create a new release, build the extension, and upload the builds to the release.
263
+
For this, please do not create a new release using the GitHub UI, you can push a new tag, and the workflow will create a new release, build the extension, and upload the builds to the release. This also supports creating [immutable releases](https://docs.github.com/en/code-security/concepts/supply-chain-security/immutable-releases).
260
264
261
-
It publishes the release by default, and then you can edit the release notes as needed, If you want to create a draft release, set the `draft` input to `true` in the `release` job.
265
+
It publishes the release by default for tag, and then you can edit the release notes as needed, If you want to create a draft release, set the `draft` input to `true` in the `release` job.
0 commit comments