empress-eco / background_tasks

Background Tasks Unleashed: An application for Task Scheduling and Automation.

Backport is a powerful GitHub action tool designed to simplify the process of backporting PRs, making developers' lives easier.
Explore the Docs · Report Bug · Request Feature

👉 About The Project

📖 Overview

Backport is a GitHub action tool specifically created to streamline the process of backporting PRs. It's designed with developers in mind, providing an efficient method for backporting to branch names.

🌟 Key Features

• Ease of Use: You can backport to any branchname simply.
• Efficiency: The tool runs after the PR merge, saving you time.
• Support: It supports squashed PRs backporting.
• Convenience: It creates a backport on Empress-pr-bot's fork of the original repository.

🛠 Technical Stack

This project is built with TypeScript, a powerful tool that ensures robustness and scalability.

🚀 Getting Started

Prerequisites

To use Backport, you need to have a basic understanding of GitHub actions and TypeScript.

Installation

To install and run Backport, follow these steps:

1. Clone the repository: git clone https://github.com/empress-eco/backport.git
2. Navigate to the repository: cd backport
3. Install NPM packages: npm install

Usage

To backport to a branchname, simply add a label on PR with the name backport branchname. You can do this either before or after merging the PR. The action will run once it's merged.

💡 Contributing

We appreciate your contributions! Here's how you can contribute:

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Please ensure you generate JavaScript files using tsc TypeScript compiler before committing.

📜 License and Acknowledgements

License

This project is under the MIT License. Your contributions are also licensed under the MIT License.

Acknowledgements

We would like to express our heartfelt gratitude to the Empress Community, the geniuses behind the essential tools that power this project. Their innovation, dedication, and pioneering work have been instrumental in building the foundations and functionalities we rely on. We are profoundly grateful for their ongoing support.