Skip to content

Commit 90d46b1

Browse files
Copilotpatinthehat
andcommitted
Fix JIRA integration docs: use .env format and add security reminder
Co-authored-by: patinthehat <5508707+patinthehat@users.noreply.github.com>
1 parent bc34f20 commit 90d46b1

1 file changed

Lines changed: 11 additions & 10 deletions

File tree

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -140,19 +140,20 @@ The `branch:recent` command can be run with the `--jira` flag to refine the orde
140140
### Configuration
141141

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

146-
```bash
147-
# Recommended: Use a secure credential manager or encrypted .env file
148-
# Store these credentials in an encrypted .env file, not in your shell profile
149-
export JIRA_API_TOKEN="your-token"
150-
export JIRA_SUBDOMAIN="acme" # for
151-
export JIRA_EMAIL_ADDRESS="you@example.com"
152-
export JIRA_EMAIL_ADDRESS="you@example.com"
153-
```
146+
2. **Configure credentials**
147+
148+
Create a `.env` file in your project root:
149+
150+
```env
151+
JIRA_API_TOKEN=your-token
152+
JIRA_SUBDOMAIN=acme
153+
JIRA_EMAIL_ADDRESS=you@example.com
154+
```
154155

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

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

0 commit comments

Comments
 (0)