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.

Sign up for GitHub

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: add link to github commit in history #113

Merged
merged 2 commits into from
Dec 5, 2024
Merged

feat: add link to github commit in history #113

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
877789d
feat: add link to github commit in history
markphelps Dec 5, 2024
ec68ffb
chore: rm looping through annotations
markphelps Dec 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions go.work.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ cloud.google.com/go/compute/metadata v0.5.0/go.mod h1:aHnloV2TPI38yx4s9+wAZhHykW
github.com/alecthomas/kingpin/v2 v2.4.0/go.mod h1:0gyi0zQnjuFk8xrkNKamJoyUo382HRL7ATRpFZCw6tE=
github.com/alecthomas/units v0.0.0-20211218093645-b94a6e3cc137/go.mod h1:OMCwj8VM1Kc9e19TLln2VL61YJF0x1XFtfdL4JdbSyE=
github.com/antihax/optional v1.0.0/go.mod h1:uupD/76wgC+ih3iEmQUL+0Ugr19nfwCT1kdvxnR2qWY=
github.com/bwesterb/go-ristretto v1.2.3/go.mod h1:fUIoIZaG73pV5biE2Blr2xEzDoMj7NFEuV9ekS419A0=
github.com/census-instrumentation/opencensus-proto v0.4.1/go.mod h1:4T9NM4+4Vw91VeyqjLS6ao50K5bOcLKN6Q42XnYaRYw=
github.com/cncf/xds/go v0.0.0-20240723142845-024c85f92f20/go.mod h1:W+zGtBO5Y1IgJhy4+A9GOqVhqLpfZi+vwmdNXUehLA8=
github.com/cncf/xds/go v0.0.0-20240905190251-b4127c9b8d78/go.mod h1:W+zGtBO5Y1IgJhy4+A9GOqVhqLpfZi+vwmdNXUehLA8=
Expand Down Expand Up @@ -56,6 +57,7 @@ golang.org/x/crypto v0.24.0/go.mod h1:Z1PMYSOR5nyMcyAVAIQSKCDwalqy85Aqn1x3Ws4L5D
golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
golang.org/x/mod v0.18.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
golang.org/x/mod v0.22.0/go.mod h1:6SkKJ3Xj0I0BrPOZoBy3bdMptDDU9oJrpohJ3eWZ1fY=
golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44=
golang.org/x/net v0.26.0/go.mod h1:5YKkiSynbBIh3p6iOc/vibscux0x38BZDkn8sCUPxHE=
golang.org/x/net v0.28.0/go.mod h1:yqtgsTWOOnlGLG9GFRrK3++bGOUEkNBoHZc8MEDWPNg=
Expand All @@ -77,6 +79,7 @@ golang.org/x/tools v0.11.0/go.mod h1:anzJrxPjNtfgiYQYirP2CPGzGLxrH2u2QBhn6Bf3qY8
golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58=
golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk=
golang.org/x/tools v0.22.0/go.mod h1:aCwcsjqvq7Yqt6TNyX7QMU2enbQ/Gt0bo6krSeEri+c=
golang.org/x/tools v0.27.0/go.mod h1:sUi0ZgbwW9ZPAq26Ekut+weQPR5eIM6GQLQ1Yjm1H0Q=
google.golang.org/genproto v0.0.0-20220822174746-9e6da59bd2fc h1:Nf+EdcTLHR8qDNN/KfkQL0u0ssxt9OhbaWCl5C0ucEI=
google.golang.org/genproto/googleapis/api v0.0.0-20240903143218-8af14fe29dc1/go.mod h1:qpvKtACPCQhAdu3PyQgV4l3LMXZEtft7y8QcarRsp9I=
google.golang.org/genproto/googleapis/api v0.0.0-20241118233622-e639e219e697/go.mod h1:+D9ySVjN8nY8YCVjc5O7PZDIdZporIDY3KaGfJunh88=
Expand Down
4 changes: 4 additions & 0 deletions internal/git/repository.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,10 @@ func (r *Repository) startPolling(ctx context.Context) {
}()
}

func (r *Repository) Remote() *config.RemoteConfig {
return r.remote
}

func (r *Repository) DefaultBranch() string {
return r.defaultBranch
}
Expand Down
40 changes: 37 additions & 3 deletions pkg/phases/git/source.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"log/slog"
"maps"
"path"
"strings"
"sync"

"github.com/get-glu/glu/internal/git"
Expand All @@ -16,11 +17,13 @@ import (
"github.com/get-glu/glu/pkg/fs"
"github.com/go-git/go-git/v5/plumbing"
"github.com/google/uuid"
giturls "github.com/whilp/git-urls"
)

const (
AnnotationGitBaseRefKey = "dev.getglu.git.base_ref"
AnnotationGitHeadSHAKey = "dev.getglu.git.head_sha"
AnnotationGitCommitURLKey = "dev.getglu.git.commit.url"
AnnotationProposalNumberKey = "dev.getglu.git.proposal.number"
AnnotationProposalURLKey = "dev.getglu.git.proposal.url"
)
Expand Down Expand Up @@ -218,10 +221,41 @@ func (p *Phase[R]) Notify(ctx context.Context, refs map[string]string) error {
return err
}

// record latest
p.log.RecordLatest(ctx, p.Descriptor(), r, map[string]string{
annotations := map[string]string{
AnnotationGitHeadSHAKey: ref,
})
}

defer func() {
// record latest
p.log.RecordLatest(ctx, p.Descriptor(), r, annotations)
}()

repoURL, err := giturls.Parse(p.repo.Remote().URLs[0])
if err != nil {
slog.Warn("while attempting to parse remote URL", "error", err)
return nil
}

// TODO: abstract this and support other SCM providers and self-hosted solutions
if !strings.HasPrefix(repoURL.Host, "github.com") {
slog.Warn("unsupported remote host", "host", repoURL.Host)
return nil
}

parts := strings.SplitN(strings.TrimPrefix(repoURL.Path, "/"), "/", 2)
if len(parts) < 2 {
slog.Warn("unexpected repository URL path", "path", repoURL.Path)
return nil
}

var (
repoOwner = parts[0]
repoName = strings.TrimSuffix(parts[1], ".git")
)

if repoOwner != "" && repoName != "" {
annotations[AnnotationGitCommitURLKey] = fmt.Sprintf("https://github.com/%s/%s/commit/%s", repoOwner, repoName, ref)
}

return nil
}
Expand Down
2 changes: 1 addition & 1 deletion ui/src/components/label.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export function Label({ labelKey, value, className }: LabelProps) {
<Badge
key={`${labelKey}-${value}`}
className={cn(
`whitespace-nowrap rounded-md text-xs font-light ${getLabelColor(labelKey, value)}`,
`whitespace-nowrap rounded-md text-xs font-medium ${getLabelColor(labelKey, value)}`,
className
)}
>
Expand Down
76 changes: 49 additions & 27 deletions ui/src/components/phase-history.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,15 @@ import {
} from '@/components/ui/dropdown-menu';
import { HoverCard, HoverCardContent, HoverCardTrigger } from '@/components/ui/hover-card';
import { useState } from 'react';
import { History, MoreVertical } from 'lucide-react';
import { Github, History, MoreVertical } from 'lucide-react';
import { cn } from '@/lib/utils';
import { useGetPhaseHistoryQuery } from '@/services/api';
import { Skeleton } from '@/components/ui/skeleton';
import { Button } from './ui/button';
import { State } from '@/types/pipeline';
import { PhaseStateDetails } from './phase-state-details';
import { PhaseRollbackDialog } from './phase-rollback-dialog';
import { ANNOTATION_GIT_COMMIT_URL } from '@/types/metadata';

interface PhaseHistoryProps {
pipelineId: string;
Expand Down Expand Up @@ -151,33 +152,54 @@ function PhaseHistoryItem({ pipelineId, phaseId, state, index }: PhaseHistoryIte
{/* history card */}
<div className="ml-6 mt-2 flex justify-between">
{/* digest and hover */}
<HoverCard>
<HoverCardTrigger asChild className="cursor-default">
<span className="inline-flex items-center truncate rounded-md bg-muted px-2 py-1">
<span className="font-mono text-xs">{state.digest?.slice(0, 30)}</span>
</span>
</HoverCardTrigger>
<HoverCardContent className="flex w-full flex-col gap-1">
<div className="text-sm">
<span className="text-foreground">Recorded At: </span>
<span className="inline-flex items-center truncate rounded-md bg-muted px-2 py-1 text-xs">
{new Date(state.recorded_at).toUTCString()}
<div className="flex flex-col gap-2">
<HoverCard>
<HoverCardTrigger asChild className="cursor-default">
<span className="inline-flex items-center truncate rounded-md bg-muted px-2 py-1">
<span className="font-mono text-xs">{state.digest?.slice(0, 30)}</span>
</span>
</div>
<div className="text-sm">
<span className="text-foreground">Digest: </span>
<span className="inline-flex items-center truncate rounded-md bg-muted px-2 py-1 font-mono text-xs">
{state.digest}
</span>
</div>
<div className="text-sm">
<span className="text-foreground">Version: </span>
<span className="inline-flex items-center truncate rounded-md bg-muted px-2 py-1 font-mono text-xs">
{state.version}
</span>
</div>
</HoverCardContent>
</HoverCard>
</HoverCardTrigger>
<HoverCardContent className="flex w-full flex-col gap-1">
<div className="text-sm">
<span className="text-foreground">Recorded At: </span>
<span className="inline-flex items-center truncate rounded-md bg-muted px-2 py-1 text-xs">
{new Date(state.recorded_at).toUTCString()}
</span>
</div>
<div className="text-sm">
<span className="text-foreground">Digest: </span>
<span className="inline-flex items-center truncate rounded-md bg-muted px-2 py-1 font-mono text-xs">
{state.digest}
</span>
</div>
<div className="text-sm">
<span className="text-foreground">Version: </span>
<span className="inline-flex items-center truncate rounded-md bg-muted px-2 py-1 font-mono text-xs">
{state.version}
</span>
</div>
</HoverCardContent>
</HoverCard>

<div className="group flex flex-row flex-wrap gap-2 hover:underline">
{Object.entries(state.annotations ?? {}).map(
([key, value]) =>
key === ANNOTATION_GIT_COMMIT_URL &&
value.startsWith('https://github.com') && (
<a
key={`${key}-${value}`}
href={value}
target="_blank"
rel="noopener noreferrer"
className="inline-flex items-center gap-1.5 px-2 py-1 text-xs"
>
<Github className="h-2.5 w-2.5" />
Commit
</a>
)
)}
</div>
</div>

{/* dropdown menu */}
<DropdownMenu>
Expand Down
36 changes: 31 additions & 5 deletions ui/src/components/phase-state-details.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ import { Label } from '@/components/label';
import { Button } from '@/components/ui/button';
import { PhaseRollbackDialog } from './phase-rollback-dialog';
import { useState } from 'react';
import { ANNOTATION_GIT_COMMIT_URL } from '@/types/metadata';
import { Github } from 'lucide-react';

interface PhaseStateDetailsProps {
isOpen: boolean;
Expand Down Expand Up @@ -70,13 +72,37 @@ export function PhaseStateDetails({
</div>
</div>

<div className="space-y-4">
<h3 className="text-lg font-semibold">Links</h3>
<div className="flex flex-row flex-wrap gap-2">
{Object.entries(state.annotations ?? {}).map(
([key, value]) =>
key === ANNOTATION_GIT_COMMIT_URL &&
value.startsWith('https://github.com') && (
<a
key={`${key}-${value}`}
href={value}
target="_blank"
rel="noopener noreferrer"
className="inline-flex items-center gap-1.5 rounded-md bg-muted px-2 py-1 text-sm hover:bg-muted/80"
>
<Github className="h-3.5 w-3.5" />
Commit
</a>
)
)}
</div>
</div>

<div className="space-y-4">
<h3 className="text-lg font-semibold">Annotations</h3>
{Object.entries(state.annotations ?? {}).map(([key, value]) => (
<div key={`${key}-${value}`} className="mb-2 flex">
<Label labelKey={key} value={value} />
</div>
))}
<div className="flex flex-row flex-wrap gap-2">
{Object.entries(state.annotations ?? {}).map(([key, value]) => (
<span key={`${key}-${value}`}>
<Label labelKey={key} value={value} />
</span>
))}
</div>
</div>

<div className="space-y-4">
Expand Down
1 change: 1 addition & 0 deletions ui/src/types/metadata.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ export type Metadata = {

export const ANNOTATION_OCI_IMAGE_URL = 'dev.getglu.oci.image.url';
export const ANNOTATION_GIT_PROPOSAL_URL = 'dev.getglu.git.proposal.url';
export const ANNOTATION_GIT_COMMIT_URL = 'dev.getglu.git.commit.url';
Loading