Skip to content

Commit 1fb4cb7

Browse files
committed
Update README.md
1 parent f45faf5 commit 1fb4cb7

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
Package Textpattern CMS plugin GitHub Action
22
=====
33

4-
This [GitHub Action](https://help.github.com/en/articles/about-github-actions) packages a source repository containing a [Textpattern CMS](https://textpattern.com) plugin and creates installers.
4+
This [GitHub Action](https://help.github.com/en/articles/about-github-actions) packages a source repository containing
5+
a [Textpattern CMS](https://textpattern.com) plugin and creates installers.
56

67
Usage
78
-----
@@ -21,7 +22,7 @@ jobs:
2122
steps:
2223

2324
- name: Checkout
24-
uses: actions/checkout@v1
25+
uses: actions/checkout@v4
2526

2627
- name: Build
2728
id: build
@@ -33,23 +34,27 @@ jobs:
3334
cat ${{ github.workspace }}/${{ steps.build.outputs.uncompressed }}
3435
```
3536
36-
See [rah_flat](https://github.com/gocom/rah_flat) repository for live [workflow examples](https://github.com/gocom/rah_flat/blob/master/.github/workflows), and [action results](https://github.com/gocom/rah_flat/actions) containing uploaded artifacts.
37+
See [rah_flat](https://github.com/gocom/rah_flat) repository for live
38+
[workflow examples](https://github.com/gocom/rah_flat/blob/master/.github/workflows), and
39+
[releases](https://github.com/gocom/rah_flat/releases) containing uploaded plugin installers.
3740
3841
Input Arguments
3942
-----
4043
4144
* **source**
42-
Path to the plugin source directory, relative to the repository root, if something else than repository root.
45+
Path to the plugin source directory containing `manifest.json`. The path is relative to the repository root. Defaults
46+
to repository root directory.
4347
* **output**
44-
Path to the output directory where build artifacts are saved to, relative to `$GITHUB_WORKSPACE`. Defaults to `build/packages`.
48+
Path to the output directory where build artifacts are saved to, relative to `$GITHUB_WORKSPACE`. Defaults to
49+
`build/packages`.
4550

4651
Output Variables
4752
-----
4853

4954
* **name**
50-
Name of the built plugin.
55+
The name of the built plugin.
5156
* **version**
52-
Version number from the manifest file.
57+
The version number from the manifest file.
5358
* **compressed**
5459
Path to the compressed plugin installer file, relative to `$GITHUB_WORKSPACE`.
5560
* **uncompressed**

0 commit comments

Comments
 (0)