README.md

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

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, and this project adheres to Semantic Versioning.

Checkout CHANGELOG.md

🤝 Contributing

If you would like to help, please take a look at the list of issues.

📜 License & Conduct

• MIT License © Varun Sridharan
• Code of Conduct

📣 Feedback

• ⭐ This repository if this project helped you! 😉
• Create An 🔧 Issue if you need help / found a bug

💰 Sponsor

I fell in love with open-source in 2013 and there has been no looking back since! You can read more about me here. 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
• ☕️☕️ How about buying me just 2 cups of coffee each month? You can do that for as little as $9.99
• 🔰 We love bettering open-source projects. Support 1-hour of open-source maintenance for $24.99 one-time?
• 🚀 Love open-source tools? Me too! How about supporting one hour of open-source development for just $49.99 one-time ?

Connect & Say 👋

• Follow me on 👨‍💻 Github and stay updated on free and open-source software
• Follow me on 🐦 Twitter to get updates on my latest open source projects
• Message me on 📠 Telegram
• Follow my pet on Instagram for some dog-tastic updates!

---

Built With ♥ By Varun Sridharan

---