Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/varunsridharan/action-wp-pot-generator

Generates POT Files for your wordpress Plugin / Theme based on the content inside Github Repo
https://github.com/varunsridharan/action-wp-pot-generator

github-action github-actions github-actions-wordpress vs-github-action wordpress wordpress-cli wordpress-development wordpress-github-actions wordpress-plugin wordpress-plugin-development wordpress-pot wordpress-pot-generator wordpress-theme wordpress-theme-development wp wp-developers wp-localization wp-plugin wp-pot wp-theme

Last synced: about 2 months ago
JSON representation

Generates POT Files for your wordpress Plugin / Theme based on the content inside Github Repo

Awesome Lists containing this project

README

        

# WordPress Pot Generator - ***Github Action***
This Action Generates POT Files for your wordpress Plugin / Theme based on the content inside Github Repo

## āš™ļø Configuration
| Key | Default | Description |
| --- | ------- | ----------- |
| `SAVE_PATH` | ./ | Location / Path to save POT File **Required** |
| `ITEM_SLUG` | NULL | Slug of your WordPress Theme / Plugin Slug **Required** |
| `DOMAIN` | NULL | WordPress Theme / Plugin ***TextDomain*** |
| `PACKAGE_NAME` | NULL | WordPress Theme / Plugin Name |
| `HEADERS` | NULL | Array in JSON format of custom headers which will be added to the POT file. Defaults to empty array. |
| `GITHUB_TOKEN` | **secret** | you do not need to generate one but you do have to explicitly make it available to the Action |

> **āš ļø Note:** You Should Provide Github Token. If Not Updated File Will Be Committed & Pushed.

## šŸš€ Example Workflow File

```yaml
name: On Push

on:
push:
branches:
- master

jobs:
WP_POT_Generator:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: WordPress POT Generator
uses: varunsridharan/[email protected]
with:
save_path: './i8n'
item_slug: 'wponion'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```

---

## šŸ“ Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

[Checkout CHANGELOG.md](https://github.com/varunsridharan/action-wp-pot-generator/blob/main/CHANGELOG.md)

## šŸ¤ Contributing
If you would like to help, please take a look at the list of [issues](https://github.com/varunsridharan/action-wp-pot-generator/issues/).

## šŸ“œ License & Conduct
- [**MIT License**](https://github.com/varunsridharan/action-wp-pot-generator/blob/main/LICENSE) Ā© [Varun Sridharan](website)
- [Code of Conduct](https://github.com/varunsridharan/.github/blob/master/CODE_OF_CONDUCT.md)

## šŸ“£ Feedback
- ā­ This repository if this project helped you! :wink:
- Create An [šŸ”§ Issue](https://github.com/varunsridharan/action-wp-pot-generator/issues/) if you need help / found a bug

## šŸ’° Sponsor
[I][twitter] fell in love with open-source in 2013 and there has been no looking back since! You can read more about me [here][website].
If you, or your company, use any of my projects or like what Iā€™m doing, kindly consider backing me. I'm in this for the long run.

- ā˜• How about we get to know each other over coffee? Buy me a cup for just [**$9.99**][buymeacoffee]
- ā˜•ļøā˜•ļø How about buying me just 2 cups of coffee each month? You can do that for as little as [**$9.99**][buymeacoffee]
- šŸ”° We love bettering open-source projects. Support 1-hour of open-source maintenance for [**$24.99 one-time?**][paypal]
- šŸš€ Love open-source tools? Me too! How about supporting one hour of open-source development for just [**$49.99 one-time ?**][paypal]

[paypal]: https://sva.onl/paypal
[buymeacoffee]: https://sva.onl/buymeacoffee
[twitter]: https://sva.onl/twitter/
[website]: https://sva.onl/website/

## Connect & Say šŸ‘‹
- **Follow** me on [šŸ‘Øā€šŸ’» Github][github] and stay updated on free and open-source software
- **Follow** me on [šŸ¦ Twitter][twitter] to get updates on my latest open source projects
- **Message** me on [šŸ“  Telegram][telegram]
- **Follow** my pet on [Instagram][sofythelabrador] for some _dog-tastic_ updates!

[sofythelabrador]: https://www.instagram.com/sofythelabrador/
[github]: https://sva.onl/github/
[twitter]: https://sva.onl/twitter/
[telegram]: https://sva.onl/telegram/

---


Built With ā™„ By Varun Sridharan




---