action-wp-pot-generator's Introduction

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

📣 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

action-wp-pot-generator's People

Contributors

Stargazers

Watchers

action-wp-pot-generator's Issues

Should the action use Plugin slug or Text domain?

Describe the bug
Thank you for this great tool. I enjoy it.

This is more of a question:

I have found that when adding the action, the item_slug is considered as the reference for the texts to add. However, WP uses the text-domain in this case, would be domain as per the code of the repo. Is this intentional?

It's not working on pull_request event

Describe the bug
It retrieves an error when trying to push the POT file to the repository when running in the pull_request context.

To Reproduce
Steps to reproduce the behavior:

Create a workflow file with the event pull_request
Open a pull request to the desired branch and see the build fails.

name: Generate POT

on:
  pull_request:
    branches:
      - test-pr

jobs:
  i18n:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Generate POT file
      uses: varunsridharan/[email protected]
      with:
        save_path: './languages'
        item_slug: 'plugin-slug'
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Expected behavior
The build should pass and with the new POT file generated and committed.

Screenshots
N/A

Desktop (please complete the following information):
N/A

Smartphone (please complete the following information):
N/A

Additional context
N/A

Recommend Projects

varunsridharan / action-wp-pot-generator Goto Github PK