import {useCallback, useEffect, useMemo, useState} from 'react'; import styled from '@emotion/styled'; import commitImage from 'sentry-images/spot/releases-tour-commits.svg'; import emailImage from 'sentry-images/spot/releases-tour-email.svg'; import resolutionImage from 'sentry-images/spot/releases-tour-resolution.svg'; import statsImage from 'sentry-images/spot/releases-tour-stats.svg'; import {openCreateReleaseIntegration} from 'sentry/actionCreators/modal'; import Access from 'sentry/components/acl/access'; import {Button} from 'sentry/components/button'; import {CodeSnippet} from 'sentry/components/codeSnippet'; import DropdownAutoComplete from 'sentry/components/dropdownAutoComplete'; import {Item} from 'sentry/components/dropdownAutoComplete/types'; import Link from 'sentry/components/links/link'; import {TourImage, TourStep, TourText} from 'sentry/components/modals/featureTourModal'; import Panel from 'sentry/components/panels/panel'; import TextOverflow from 'sentry/components/textOverflow'; import {Tooltip} from 'sentry/components/tooltip'; import {IconAdd} from 'sentry/icons'; import {t} from 'sentry/locale'; import {space} from 'sentry/styles/space'; import {Organization, Project, SentryApp} from 'sentry/types'; import {trackAnalytics} from 'sentry/utils/analytics'; import useApi from 'sentry/utils/useApi'; import useApiRequests from 'sentry/utils/useApiRequests'; const releasesSetupUrl = 'https://docs.sentry.io/product/releases/'; const docsLink = ( {t('Setup')} ); export const RELEASES_TOUR_STEPS: TourStep[] = [ { title: t('Suspect Commits'), image: , body: ( {t( 'Sentry suggests which commit caused an issue and who is likely responsible so you can triage.' )} ), actions: docsLink, }, { title: t('Release Stats'), image: , body: ( {t( 'Get an overview of the commits in each release, and which issues were introduced or fixed.' )} ), actions: docsLink, }, { title: t('Easily Resolve'), image: , body: ( {t( 'Automatically resolve issues by including the issue number in your commit message.' )} ), actions: docsLink, }, { title: t('Deploy Emails'), image: , body: ( {t( 'Receive email notifications about when your code gets deployed. This can be customized in settings.' )} ), }, ]; type Props = { organization: Organization; project: Project; }; const ReleasesPromo = ({organization, project}: Props) => { const {data, renderComponent, isLoading} = useApiRequests<{ internalIntegrations: SentryApp[]; }>({ endpoints: [ [ 'internalIntegrations', `/organizations/${organization.slug}/sentry-apps/`, {query: {status: 'internal'}}, ], ], }); const api = useApi(); const [token, setToken] = useState(null); const [integrations, setIntegrations] = useState([]); const [selectedItem, selectItem] = useState | null>(null); useEffect(() => { if (!isLoading && data.internalIntegrations) { setIntegrations(data.internalIntegrations); } }, [isLoading, data.internalIntegrations]); useEffect(() => { trackAnalytics('releases.quickstart_viewed', { organization, project_id: project.id, }); // eslint-disable-next-line react-hooks/exhaustive-deps }, []); const trackQuickstartCopy = useCallback(() => { trackAnalytics('releases.quickstart_copied', { organization, project_id: project.id, }); }, [organization, project]); const trackQuickstartCreatedIntegration = useCallback( (integration: SentryApp) => { trackAnalytics('releases.quickstart_create_integration.success', { organization, project_id: project.id, integration_uuid: integration.uuid, }); }, [organization, project] ); const trackCreateIntegrationModalClose = useCallback(() => { trackAnalytics('releases.quickstart_create_integration_modal.close', { organization, project_id: project.id, }); }, [organization, project.id]); const fetchToken = async sentryAppSlug => { const tokens = await api.requestPromise(`/sentry-apps/${sentryAppSlug}/api-tokens/`); if (!tokens.length) { const newToken = await generateToken(sentryAppSlug); return setToken(newToken); } return setToken(tokens[0].token); }; const generateToken = async (sentryAppSlug: string) => { const newToken = await api.requestPromise( `/sentry-apps/${sentryAppSlug}/api-tokens/`, { method: 'POST', } ); return newToken.token; }; const renderIntegrationNode = (integration: SentryApp) => { return { value: {slug: integration.slug, name: integration.name}, searchKey: `${integration.name}`, label: ( {integration.name} ), }; }; const codeChunks = useMemo( () => [ `# Install the cli curl -sL https://sentry.io/get-cli/ | bash # Setup configuration values SENTRY_AUTH_TOKEN=`, token && selectedItem ? `${token} # From internal integration: ${selectedItem.value.name}` : '', ` SENTRY_ORG=${organization.slug} SENTRY_PROJECT=${project.slug} VERSION=\`sentry-cli releases propose-version\` # Workflow to create releases sentry-cli releases new "$VERSION" sentry-cli releases set-commits "$VERSION" --auto sentry-cli releases finalize "$VERSION"`, ], [token, selectedItem, organization.slug, project.slug] ); return renderComponent( {t('Set up Releases')} {t('Full Documentation')} {t( 'Find which release caused an issue, apply source maps, and get notified about your deploys.' )} {t( 'Add the following commands to your CI config when you deploy your application.' )} {codeChunks.join('')} {codeChunks[0]} { // This can be called multiple times and does not always have `event` e?.stopPropagation(); }} items={[ { label: {t('Available Integrations')}, id: 'available-integrations', items: (integrations || []).map(renderIntegrationNode), }, ]} alignMenu="left" onSelect={({label, value}) => { selectItem({label, value}); fetchToken(value.slug); }} itemSize="small" searchPlaceholder={t('Select Internal Integration')} menuFooter={ {({hasAccess}) => ( openCreateReleaseIntegration({ organization, project, onCreateSuccess: (integration: SentryApp) => { setIntegrations([integration, ...integrations]); const {label, value} = renderIntegrationNode(integration); selectItem({ label, value, }); fetchToken(value.slug); trackQuickstartCreatedIntegration(integration); }, onCancel: () => { trackCreateIntegrationModalClose(); }, }) } > {t('Create New Integration')} )} } disableLabelPadding emptyHidesInput > {() => {codeChunks[1]}} {codeChunks[2]} ); }; const Container = styled('div')` padding: ${space(3)}; `; const ContainerHeader = styled('div')` display: flex; justify-content: space-between; align-items: center; margin-bottom: ${space(3)}; min-height: 32px; h3 { margin: 0; } @media (max-width: ${p => p.theme.breakpoints.small}) { flex-direction: column; align-items: flex-start; h3 { margin-bottom: ${space(2)}; } } `; const CodeSnippetWrapper = styled('div')` position: relative; `; /** * CodeSnippet stringifies all inner children (due to Prism code highlighting), so we * can't put CodeSnippetDropdown inside of it. Instead, we can render a pre wrap * containing the same code (without Prism highlighting) with CodeSnippetDropdown in the * middle and overlay it on top of CodeSnippet. */ const CodeSnippetOverlay = styled('pre')` position: absolute; top: 0; bottom: 0; left: 0; right: 0; z-index: 2; margin-bottom: 0; pointer-events: none; && { background: transparent; } `; /** * Invisible code span overlaid on top of the highlighted code. Exists only to * properly position inside . */ const CodeSnippetOverlaySpan = styled('span')` visibility: hidden; `; const CodeSnippetDropdownWrapper = styled('span')` /* Re-enable pointer events (disabled by CodeSnippetOverlay) */ pointer-events: initial; `; const CodeSnippetDropdown = styled(DropdownAutoComplete)` position: absolute; font-family: ${p => p.theme.text.family}; border: none; border-radius: 4px; width: 300px; `; const GroupHeader = styled('div')` font-size: ${p => p.theme.fontSizeSmall}; font-family: ${p => p.theme.text.family}; font-weight: 600; margin: ${space(1)} 0; color: ${p => p.theme.subText}; line-height: ${p => p.theme.fontSizeSmall}; text-align: left; `; const CreateIntegrationLink = styled(Link)` color: ${p => (p.disabled ? p.theme.disabled : p.theme.textColor)}; `; const MenuItemWrapper = styled('div')<{ disabled?: boolean; py?: number; }>` cursor: ${p => (p.disabled ? 'not-allowed' : 'pointer')}; display: flex; align-items: center; font-family: ${p => p.theme.text.family}; font-size: 13px; ${p => typeof p.py !== 'undefined' && ` padding-top: ${p.py}; padding-bottom: ${p.py}; `}; `; const MenuItemFooterWrapper = styled(MenuItemWrapper)` padding: ${space(0.25)} ${space(1)}; border-top: 1px solid ${p => p.theme.innerBorder}; background-color: ${p => p.theme.tag.highlight.background}; color: ${p => p.theme.active}; :hover { color: ${p => p.theme.activeHover}; svg { fill: ${p => p.theme.activeHover}; } } `; const IconContainer = styled('div')` display: flex; align-items: center; justify-content: center; width: 24px; height: 24px; flex-shrink: 0; `; const Label = styled(TextOverflow)` margin-left: 6px; `; export default ReleasesPromo;
{t( 'Find which release caused an issue, apply source maps, and get notified about your deploys.' )}
{t( 'Add the following commands to your CI config when you deploy your application.' )}