cloudamqp / cloudamqp/cli

Rename CLOUDAMQP_URL variable

Open
#30 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
2
Forks
1
PR merge metrics
No merged PRs in 30d

Description

I noticed that CLOUDAMQP_URL is used a lot in our documentation for holding the AMQP connection string. To avoid conflicts with the CLI and our docs example code I propose a change in client/client.go from CLOUDAMQP_URL to CLOUDAMQP_API_URL or CLOUDAMQP_API_BASE_URL
https://github.com/cloudamqp/cli/blob/5458022aaf376e877b34a5eb8a4ba53ad09a5f10/client/client.go#L25

The CLI is not satisfied with CLOUDAMQP_URL emptied and will attempt to use the AMQP connection string if set.

Happy to create a PR if this is accepted or other way to handle the env conflicts.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with client/client.go at line 25 and search the repository documentation for references to CLOUDAMQP_URL. Confirm the accepted replacement name and update the relevant references so the CLI no longer treats an AMQP connection string as its API URL; verify the changed usage is consistent across the documentation and client code.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.