Skip to content

Commit 076b2da

Browse files
committed
Improve README
1 parent 4b7cc61 commit 076b2da

File tree

5 files changed

+13
-9
lines changed

5 files changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ This project provides PowerShell packages and GitHub Actions to build PHP and it
1616
- [PHP Version Support](#php-version-support)
1717
- [Release](#release)
1818
- [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)
2122

2223
- [Local Setup](#local-setup)
2324
- [PHP](#php)
@@ -185,11 +186,14 @@ Upload the artifacts to a release.
185186
- `token` (optional): The GitHub token to authenticate with. Defaults to `GITHUB_TOKEN` secret.
186187
- `draft` (optional): Whether to create a draft release if the release does not exist. Defaults to `false`.
187188

188-
#### Example workflow for non-immutable releases
189189

190-
Follow this if you are creating the release, and they are not immutable (This is the default).
190+
### Examples
191191

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.
193197

194198
```yaml
195199
name: Build extension
@@ -252,13 +256,13 @@ jobs:
252256
token: ${{ secrets.GITHUB_TOKEN }}
253257
```
254258

255-
#### Example workflow for immutable releases
259+
#### Workflow for tags
256260

257-
Follow this if you are using immutable releases.
261+
Follow this workflow if you are using tags to release new versions.
258262

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).
260264

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.
262266

263267
```yaml
264268
name: Build extension
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)