🚀 Elfsquad Jira Deployment GitHub Action

• 🌟 Features
• 📋 Prerequisites
• 🛠 Setup
• 📖 Usage
• 🤝 Contributing
• ⚖️ License
• ✨ Acknowledgements

🌟 Features

This GitHub Action 🤖 makes your CI/CD pipeline more integrated by automatically publishing your GitHub releases as deployments 🚀 in Jira. It bridges the gap between code commits and project tracking in Jira, bringing transparency and efficiency to your software development process.

📋 Prerequisites

Before you dive in, make sure you have:

• A Jira account 🧑‍💻

• OAuth credentials (client ID and client secret) for your Jira installation 🔐

🛠 Setup

Setting up this action is as easy as pie 🍰:

1. Step 1: Get your Jira OAuth credentials ready.

2. Step 2: Add your Jira base URL and other secrets to your GitHub repository’s secrets.

3. Step 3: Add the action to your workflow.

📖 Usage

To use this action in your workflow, add the following snippet into your .yml file:

- name: Deploy to Jira
  uses: Elfsquad/jira-deployment@1.0.5
  with:
    client-id: ${{ secrets.JIRA_CLIENT_ID }}
    client-secret: ${{ secrets.JIRA_CLIENT_SECRET }}
    base-url: ${{ secrets.JIRA_BASE_URL }}
    issue-keys: 'ISSUE-123,ISSUE-456'
    display-name: 'My Awesome Deployment'
    # Optional inputs below
    state: 'successful' # Default: 'successful'
    environment-id: 'production' # Default: 'production'
    environment-type: 'production' # Default: 'production'
    environment-display-name: 'Production' # Default: 'Production'

🤝 Contributing

We welcome contributions! Please feel free to fork the repository, make your changes, and submit a pull request.

⚖️ License

Licensed under the AGPL-3.0. See the LICENSE file in the repository for full details.

✨ Acknowledgements

A big thank you to everyone who contributes to the ongoing development and maintenance of this action.