Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
version: 2
updates:
# Python dependencies
- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "weekly"
day: "monday"
open-pull-requests-limit: 10
groups:
dev-dependencies:
patterns:
- "black"
- "isort"
- "flake8*"
- "bandit"
- "pre-commit"
- "pytest*"
versioning-strategy: "lockfile-only"
labels:
- "dependencies"
- "python"

# GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
day: "monday"
open-pull-requests-limit: 10
labels:
- "dependencies"
- "github-actions"
35 changes: 35 additions & 0 deletions .github/workflows/quality.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Quality Checks

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]

jobs:
quality:
name: Code Quality
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.12'
cache: 'pip'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install poetry
poetry install --with dev

- name: Check file formatting
run: |
# Check for files that would be reformatted by black
poetry run black . --check --diff
# Check import sorting
poetry run isort . --check-only --diff
# Check code style
poetry run flake8 .
29 changes: 29 additions & 0 deletions .github/workflows/security.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Security Checks

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]

jobs:
security:
name: Security Scan
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.12'
cache: 'pip'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install poetry
poetry install --with dev

- name: Run Bandit
run: poetry run bandit -c pyproject.toml -r . -ll
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Changelog

## [1.0.0] - 2025-01-22

Initial release:

- Download JIRA tickets to local filesystem
- Maintain hierarchy (initiatives -> epics -> stories)
- Support for single ticket or recursive downloads
7 changes: 7 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# MIT License

Copyright 2025 Brad Edwards

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
[![Quality Checks](https://github.com/KeplerOps/Ground-Control/actions/workflows/quality.yml/badge.svg)](https://github.com/KeplerOps/Ground-Control/actions/workflows/quality.yml)
[![Security Checks](https://github.com/KeplerOps/Ground-Control/actions/workflows/security.yml/badge.svg)](https://github.com/KeplerOps/Ground-Control/actions/workflows/security.yml)

# Ground Control

Download JIRA tickets to your filesystem. Keeps the hierarchy (initiatives -> epics -> stories) intact.

## Setup

1. Create a JIRA API token

2. Set environment variables:

```bash
JIRA_URL=https://your-org.atlassian.net
JIRA_PROJECT=YOUR-PROJECT
JIRA_USERNAME=your.email@example.com
JIRA_API_TOKEN=your-token
```

## Install

```bash
pip install poetry
poetry install
```

## Usage

```bash
# Download all tickets
poetry run ground-control

# Download a specific ticket
poetry run ground-control PROJ-123

# Download a ticket and its children
poetry run ground-control PROJ-123 -r

# Use a different output directory
poetry run ground-control -o /path/to/dir
```
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ build-backend = 'setuptools.build_meta'

[tool.poetry]
name = "ground-control"
version = "0.1.0"
version = "1.0.0"
description = "A tool for syncing Jira tickets with local files"
authors = ["Your Name <your.email@example.com>"]
authors = ["Brad Edwards <j.bradley.edwards@gmail.com>"]

[tool.poetry.dependencies]
python = "^3.12"
Expand Down