Skip to content

Update env_setup.sh.example to recommend API tokens - #215

Open
jvrck wants to merge 1 commit into
masterfrom
update-env-setup-example
Open

jvrck wants to merge 1 commit into
masterfrom
update-env-setup-example

Conversation

@jvrck

@jvrck jvrck commented Mar 22, 2026

Copy link
Copy Markdown
Owner

Changes

Updates env_setup.sh.example to align with the API token migration strategy introduced in v1.2.7.

What changed

  • Restructured to match docenv.example format
  • Option 1 (Recommended): API tokens - uncommented and ready to use
  • Option 2 (Legacy): App passwords - commented out with deprecation warnings
  • Added BB_TEST_COUNTER as an optional setting
  • Added clear deprecation timeline (June 9, 2026)

Why

In v1.2.7, API token support was added and docenv.example was updated, but env_setup.sh.example still only showed app password variables. This closes that gap.

Related

  • Closes the documentation gap from v1.2.7 (2026-03-05)
  • Consistent with Atlassian's deprecation timeline
  • Matches the pattern already established in docenv.example

- Align with docenv.example format
- Show API tokens as recommended method (Option 1)
- Move app password to legacy section (Option 2)
- Add deprecation warnings matching other documentation
- Add BB_TEST_COUNTER as optional setting

Closes gap where env_setup.sh.example was not updated in v1.2.7 when
API token support was added.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 85f24d2af7

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread env_setup.sh.example
Comment on lines +14 to +15
export BB_EMAIL=your.email@example.com
export BB_API_TOKEN=ATBBxxx...

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Comment out the API-token block by default

For users who still need the legacy app-password flow before June 9, 2026, this template is now misleading: bb-ripper/auth_helper.py:get_auth_mode() switches to API-token auth whenever BB_API_TOKEN exists, regardless of whether BB_USER/BB_PASSWORD are also set. Because this file exports BB_API_TOKEN unconditionally, someone who follows the “Choose ONE” instructions and only uncomments Option 2 will still be forced down the token path and get auth failures until they realize they must also re-comment Option 1.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant