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

feat(releases): Update docs to use GitHub App instead of service account PAT #11805

Draft
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

Jeffreyhung
Copy link
Member

DESCRIBE YOUR PR

We are planning to replace the current usage of getsentry-release bot with a GitHub App, this PR will update the docs to include updated code template.

More details: https://www.notion.so/sentry/DACI-Replace-GitHub-bot-accounts-with-GitHub-Apps-getsentry-release-15109965d1204a91b9be71c49e8b66e0?pvs=4

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

Copy link

vercel bot commented Nov 12, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
develop-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 14, 2024 10:46pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Nov 14, 2024 10:46pm
sentry-docs ⬜️ Ignored (Inspect) Visit Preview Nov 14, 2024 10:46pm

@Jeffreyhung Jeffreyhung changed the title use Github App instead of PAT feat(releases): Update docs to use GitHub App instead of service account PAT Nov 12, 2024
Copy link

codecov bot commented Nov 13, 2024

Bundle Report

Changes will increase total bundle size by 312 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 8.59MB 318 bytes (0.0%) ⬆️
sentry-docs-client-array-push 8.94MB 6 bytes (-0.0%) ⬇️


You can do this self-service via the settings page of your repository:
`https://github.com/getsentry/REPONAME_HERE/settings/access`

## Create ruleset for the repo

Download and save the [default ruleset template](https://docs.sentry.io/json/Default_ruleset.json) as a JSON file.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This url s 404ing for me, is it correct?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Ah, I see the issue here, let's change it to a relative url:

Suggested change
Download and save the [default ruleset template](https://docs.sentry.io/json/Default_ruleset.json) as a JSON file.
Download and save the [default ruleset template](/json/Default_ruleset.json) as a JSON file.

Copy link
Member Author

Choose a reason for hiding this comment

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

@coolguyzone the changes I'm making to are on develop.sentry.dev, and the JSON is hosted on docs.sentry.io, hence I don't think the relative URL will work.
I would love to move the JSON over under the develop domain, but I'm not sure how to do that, any suggestions?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Ah, fair point. In that case, the absolute URL makes sense.

Copy link
Collaborator

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

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

Looks good to me, I added a suggestion to reformat one of the links.

Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

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

LGTM

develop-docs/sdk/processes/releases.mdx Outdated Show resolved Hide resolved
develop-docs/sdk/processes/releases.mdx Outdated Show resolved Hide resolved
develop-docs/sdk/processes/releases.mdx Outdated Show resolved Hide resolved
@Jeffreyhung
Copy link
Member Author

Will be waiting for approval on the devinfra side on this before rolling this out

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.

3 participants