Skip to content

Commit 4841ff0

Browse files
authored
Merge pull request #30 from permafrost-dev/copilot/sub-pr-23
[WIP] Update JIRA integration instructions in README.md
2 parents 197f8b6 + f292144 commit 4841ff0

2 files changed

Lines changed: 12 additions & 11 deletions

File tree

.github/workflows/run-tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313
run-tests:
1414
runs-on: ubuntu-latest
1515
env:
16-
GO_VERSION: "~1.23"
16+
GO_VERSION: "~1.25"
1717
GO111MODULE: "on"
1818
USE_CODECOV: true
1919

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)