Skip to content

Commit 1ef90ea

Browse files
misc: readme/action description cleanup
1 parent 37a57ac commit 1ef90ea

File tree

3 files changed

+24
-24
lines changed

3 files changed

+24
-24
lines changed

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -41,29 +41,13 @@ jobs:
4141
| --- | ----------- | ----------- |----|
4242
| `manifest-path` | The relative path of the manifest file | Required | - |
4343
| `bundle` | The bundle name | Optional | `app.flatpak` |
44-
| `repository-name` | The repository name to fetch the runtime when building the application/user installs it. | Optional | `flathub` |
45-
| `repository-url` | The repository url used to fetch the runtime when the user download the Flatpak bundle or when building the application. | Optional | `https://flathub.org/repo/flathub.flatpakrepo` |
46-
| `run-tests` | Enable/Disable running tests. | Optional | `false` |
47-
| `branch` | The default flatpak branch. | Optional | `master` |
44+
| `repository-name` | The repository name, used to fetch the runtime when the user download the Flatpak bundle or when building the application | Optional | `flathub` |
45+
| `repository-url` | The repository url, used to fetch the runtime when the user download the Flatpak bundle or when building the application | Optional | `https://flathub.org/repo/flathub.flatpakrepo` |
46+
| `run-tests` | Enable/Disable running tests | Optional | `false` |
47+
| `branch` | The default flatpak branch | Optional | `master` |
4848
| `cache` | Enable/Disable caching `.flatpak-builder` directory | Optional | `true` |
4949
| `cache-key` | Specifies the cache key | Optional | `flatpak-builder-${sha256(manifestPath)}` |
5050

51-
#### Docker Image
52-
53-
The Docker image used for the action consists of 2 parts: The base image, based on Fedora and which can be found
54-
[here](docker/Dockerfile), and the specific image of the runtime you choose, which is generated through
55-
[this](.github/workflows/docker.yml) GitHub Actions workflow.
56-
57-
You can specify the specific runtime you need to use through the image tags:
58-
59-
| Runtime | Version | Tag | Example |
60-
| --------------- | ------- | ------------------- | ---------------------------------------------------------------- |
61-
| Freedesktop SDK | 20.08 | `freedesktop-20.08` | `image: bilelmoussaoui/flatpak-github-actions:freedesktop-20.08` |
62-
| GNOME | 3.38 | `gnome-3.38` | `image: bilelmoussaoui/flatpak-github-actions:gnome-3.38` |
63-
| GNOME | 40 | `gnome-40` | `image: bilelmoussaoui/flatpak-github-actions:gnome-40` |
64-
| KDE | 5.15 | `kde-5.15` | `image: bilelmoussaoui/flatpak-github-actions:kde-5.15` |
65-
| elementary BaseApp | juno | `juno` | `image: bilelmoussaoui/flatpak-github-actions:elementary-juno` |
66-
6751
### Deployment stage
6852

6953
If you want to deploy the successfully built Flatpak application to a remote repository
@@ -102,3 +86,19 @@ jobs:
10286
| `repository` | The repository to push the build into | Required | - |
10387
| `flat-manager-url` | The flat-manager remote URL | Required | - |
10488
| `token` | A flat-manager token | Required | - |
89+
90+
### Docker Image
91+
92+
The Docker image used for the action consists of 2 parts: The base image, based on Fedora and which can be found
93+
[here](docker/Dockerfile), and the specific image of the runtime you choose, which is generated through
94+
[this](.github/workflows/docker.yml) GitHub Actions workflow.
95+
96+
You can specify the specific runtime you need to use through the image tags:
97+
98+
| Runtime | Version | Tag | Example |
99+
| --------------- | ------- | ------------------- | ---------------------------------------------------------------- |
100+
| Freedesktop SDK | 20.08 | `freedesktop-20.08` | `image: bilelmoussaoui/flatpak-github-actions:freedesktop-20.08` |
101+
| GNOME | 3.38 | `gnome-3.38` | `image: bilelmoussaoui/flatpak-github-actions:gnome-3.38` |
102+
| GNOME | 40 | `gnome-40` | `image: bilelmoussaoui/flatpak-github-actions:gnome-40` |
103+
| KDE | 5.15 | `kde-5.15` | `image: bilelmoussaoui/flatpak-github-actions:kde-5.15` |
104+
| elementary BaseApp | juno | `juno` | `image: bilelmoussaoui/flatpak-github-actions:elementary-juno` |

flat-manager/action.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: "flat-manager"
1+
name: "Flatpak Manager"
22
description: "Deploy your Flatpak application to a repository"
33
author: "Bilal Elmoussaoui"
44
branding:
@@ -15,7 +15,7 @@ inputs:
1515
required: true
1616
token:
1717
description: >
18-
A flat-manager token to publish into the repository
18+
A flat-manager token to publish into the repository.
1919
required: true
2020
runs:
2121
using: "node12"

flatpak-builder/action.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: "Flatpak Builder"
2-
description: "Flatpak Applications Builder"
2+
description: "Build and create a bundle from a Flatpak manifest"
33
author: "Bilal Elmoussaoui"
44
branding:
55
icon: "package"
@@ -42,7 +42,7 @@ inputs:
4242
Defaults to flatpak-builder-${sha256(manifestPath)}
4343
required: false
4444
branch:
45-
description: The flatpak branch
45+
description: The flatpak branch.
4646
default: "master"
4747
required: false
4848
runs:

0 commit comments

Comments
 (0)