search

semaphoreci / docs

Semaphore 2.0 documentation.
https://docs.semaphoreci.com
18 stars 83 forks source link

It is difficult to see the CLI widget and the access token #1435

Open dimitar-peychinov opened 5 months ago

dimitar-peychinov commented 5 months ago

On the CLI documentation https://docs.semaphoreci.com/reference/sem-command-line-tool/ it is stated that

You can find the exact sem connect command, which includes your current organization's name and access token, by selecting the CLI widget in the top-right corner of any screen on Semaphore.

Your access token is always available, and revokable, on your account page.

So there are two suggestions how to find the access token. I tried both but none of them worked. Here are the details:

1. The CLI widget seems to be missing

Here's what I see:

Screenshot 2024-05-20 at 14 23 09

And here is what I expected to see (source: https://semaphoreci.medium.com/ci-cd-for-microservices-on-digitalocean-kubernetes-b913fa0b3404):

code_icon

The code icon is not visible (at least for me).

2. I can not see my access token on my account/profile page.

Here's what I see:

Screenshot 2024-05-20 at 14 30 55

If the API token is the access token that I need, then I can't copy/get it from here either.

I assume that my organisation settings or my account's permissions in the organisation may have something to do with this - but if that's the reason then it would be nice to have a note about it in the documentation.

Update:

Later today I saw CLI widget:

Screenshot 2024-05-20 at 14 52 09

And I thought "Here's the access token now!" - but to my disappointment the "full command" only stated sem connect studitemps.semaphoreci.com _YOUR_API_TOKEN_ :(

So, to further add some details to the questions/issues above:

  1. The CLI widget is not shown "on any screen" in Semaphore - just on some, and I can't tell on which ones.
  2. This is not "top right" (as stated in the documentation) - it's more like top-left-after-some-titles. :)
  3. The connect command does not (anymore?) include the actual token - but a placeholder instead - _YOUR_APITOKEN Screenshot 2024-05-20 at 15 07 19

I assume that's a security improvement, but let's not leave the documentation behind. :)

radwo commented 5 months ago

Hi Dimitar,

Thank you for reaching out!

Some time ago, to tighten the security of the API token, we made it readable only once during its creation. If you lose it, you will need to regenerate it. Sorry for the inconvenience.

Once again, thank you for the feedback. We'll make sure to update the documentation as needed.

radwo commented 5 months ago

I merged the changes to the documentation and will close this ticket now. Feel free to reopen it if you have any concerns.

dimitar-peychinov commented 5 months ago

Hello @radwo and thank you for the swift feedback and for addressing the issue by updating the documentation.

However, it seems to me that the wording is still a bit confusing:

You can find your token by visiting your account settings.

Not really, you can only regenerate it there, you can't find/read/get it there, right?

You can find the exact sem connect command, which includes your current organization's, by selecting the CLI widget in the top-right corner of any screen on Semaphore.

Imo this sentence got worse after the change - as now it's not clear that it includes the org name. Also, it still mentions top-right - and it's not there for me - it's next to the title, so if it's a long title, then it may go to the right, but if it's a short one, then it's to the left. It also keeps saying that it's on "any screen" on Semaphore which doesn't seem to be the case.

radwo commented 5 months ago

You are right. The quick fix here didn't do the trick. I will revisit that documentation during the week. Thanks for pointing this out.