Skip to content

Fix JIRA integration docs: use .env format, wrap bare URL, add security reminder #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
patinthehat merged 3 commits into from
Dec 10, 2025
Merged

Fix JIRA integration docs: use .env format, wrap bare URL, add security reminder #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bc34f20
Initial plan
Copilot Dec 10, 2025
90d46b1
Fix JIRA integration docs: use .env format and add security reminder
Copilot Dec 10, 2025
f292144
Update Go version in CI workflow to 1.25
patinthehat Dec 10, 2025
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
2 changes: 1 addition & 1 deletion .github/workflows/run-tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
run-tests:
runs-on: ubuntu-latest
env:
GO_VERSION: "~1.23"
GO_VERSION: "~1.25"
GO111MODULE: "on"
USE_CODECOV: true

Expand Down
21 changes: 11 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,19 +140,20 @@ The `branch:recent` command can be run with the `--jira` flag to refine the orde
### Configuration

1. **Create an API token**
- Visit <https://id.atlassian.com/manage-profile/security/api-tokens>.
- Visit [Atlassian API Tokens](https://id.atlassian.com/manage-profile/security/api-tokens).
- Click **Create API token** and copy the generated value.

```bash
# Recommended: Use a secure credential manager or encrypted .env file
# Store these credentials in an encrypted .env file, not in your shell profile
export JIRA_API_TOKEN="your-token"
export JIRA_SUBDOMAIN="acme" # for
export JIRA_EMAIL_ADDRESS="you@example.com"
export JIRA_EMAIL_ADDRESS="you@example.com"
```
2. **Configure credentials**

Create a `.env` file in your project root:

```env
JIRA_API_TOKEN=your-token
JIRA_SUBDOMAIN=acme
JIRA_EMAIL_ADDRESS=you@example.com
```

Add these to your shell profile or `.env` file so `git-ninja` can authenticate with JIRA.
**Important:** Do not commit `.env` to version control. Add it to `.gitignore` to keep your credentials secure.

3. **Run `branch:recent` with the `--jira` flag**

Expand Down
Loading