Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ref(docs): Update README with more info on prerequisites #234

Merged
merged 4 commits into from
Jan 21, 2025

Conversation

andreiborza
Copy link
Member

Small refactor to make it clearer what secrets need to be set.

Copy link
Member

@szokeasaurusrex szokeasaurusrex left a comment

Choose a reason for hiding this comment

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

I think this is a generally good refactor, but imo this is a bit too much information for what should be a simple guide to cover the basic use cases


Alternatively, you can also use a [User Auth Token](https://docs.sentry.io/account/auth-tokens/#user-auth-tokens), with the "Project: Read & Write" and "Release: Admin" permissions.

You also need to set your Organization and Project slugs and if you're using a self-hosted Sentry instance, provide the URL used to connect to Sentry via SENTRY_URL.
Copy link
Member

Choose a reason for hiding this comment

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

The organization and Sentry URL are encoded in the org auth token. We recommend that users do not manually set these when they are using an org auth token. Users should only need to set the project slug.

Suggested change
You also need to set your Organization and Project slugs and if you're using a self-hosted Sentry instance, provide the URL used to connect to Sentry via SENTRY_URL.
You also need to set your project slug.

Copy link
Member Author

Choose a reason for hiding this comment

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

Does that hold true for self-hosted too?

Anyway, this isn't a simple docs/readme change as the action has code that depends on these. We can think of removing in another issue. Let's discuss this in our meeting.

Copy link
Member

Choose a reason for hiding this comment

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

Yes, it applies to self hosted (minus, some old self-hosted versions that did not encode the URL due to a bug). Sentry CLI (at least for the URL, not sure about the org) will ignore the manually provided values and use the ones encoded in the token, and it also issues a warning in case of a difference.

The whole point of encoding the URL and org in the token was to eliminate the need to manually specify them, so we should definitely remove any code that depends on these being manually provided from the GitHub action

Copy link
Member Author

Choose a reason for hiding this comment

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

As discussed, let's tackle this in #212

Copy link
Member

Choose a reason for hiding this comment

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

#212 seems to imply we would need to make these changes in a major release, but I think we can make them in a minor release, too

Copy link
Member Author

Choose a reason for hiding this comment

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

We can, but priority wise we want to tackle a new major first.

andreiborza and others added 3 commits January 21, 2025 15:42
Co-authored-by: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>
Co-authored-by: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>
Co-authored-by: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>
@andreiborza andreiborza merged commit 417d443 into master Jan 21, 2025
4 checks passed
@andreiborza andreiborza deleted the ab/update-readme branch January 21, 2025 15:36
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.

2 participants