Skip to content
This repository has been archived by the owner on Jun 28, 2024. It is now read-only.

(README) Update example and parameters list #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 18 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,17 @@ jobs:

steps:
- name: Checkout repository
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Update .pot
uses: AdwCustomizerTeam/action-update-pot@main
uses: GradienceTeam/action-update-pot@main
with:
title: "Adwaita Manager POT file"
copyright: "Adwaita Manager Team"
title: "Gradience POT file"
copyright: "Gradience Team"
license: "GNU GPLv3"
author: "Adwaita Manager Team"
author: "Gradience Team"
commiter: "Gradience Bot"
commiter_email: "[email protected]"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Expand All @@ -45,12 +47,14 @@ jobs:

You must also provide an `GITHUB_TOKEN` in `env`

| Name | Description | Default | Required |
| ------------------ | ------------------------------------------------------------------------- | ------------------ | -------- |
| `destination_path` | Destination path to save generated .pot file | `/po` | false |
| `slug` | Project slug. Defaults to the Github repository name. | $GITHUB_REPOSITORY | false |
| `text_domain` | Text domain to look for in the source code. Defaults to the project slug. | `slug` | false |
| `title` | Replace "SOME DESCRIPTIVE TITLE."' | | false |
| `copyright` | Replace "YEAR THE PACKAGE S COPYRIGHT HOLDER"' | | false |
| `license` | Replace "same license as the PACKAGE package"' | | False |
| `author` | Replace "FIRST AUTHOR <EMAIL@ADDRESS>"' | | false |
| Name | Description | Default | Required |
|--------------------|---------------------------------------------------------------------------|---------------------------------------------------------|----------|
| `destination_path` | Destination path to save generated .pot file | `/po` | false |
| `slug` | Project slug. Defaults to the Github repository name. | $GITHUB_REPOSITORY | false |
| `text_domain` | Text domain to look for in the source code. Defaults to the project slug. | `slug` | false |
| `title` | Replace "SOME DESCRIPTIVE TITLE."' | | false |
| `copyright` | Replace "YEAR THE PACKAGE S COPYRIGHT HOLDER"' | | false |
| `license` | Replace "same license as the PACKAGE package"' | | False |
| `author` | Replace "FIRST AUTHOR <EMAIL@ADDRESS>"' | | false |
| `commiter` | Setting committer | `github-actions[bot]` | false |
| `commiter_email` | Setting committer email | `41898282+github-actions[bot]@users.noreply.github.com` | false |