2 |
3 |
4 |
5 |
8 | Transform your changelog Markdown files to beautiful product updates
9 |
10 |
11 | Website
12 | ·
13 | Docs
14 | ·
15 | Get Started
16 | ·
17 | Demo
18 |
{ a.Description }
40 |{ a.PublishedAt.Format("02 Jan 2006") }
43 | } 44 |15 | { children... } 16 |
17 | 18 | } 19 | 20 | templ ForwardButton(link string) { 21 | 26 |27 | { children... } 28 |
29 | 30 | @icons.ChevronRight(16, 16) 31 | 32 | 33 | } 34 | -------------------------------------------------------------------------------- /components/changelog.templ: -------------------------------------------------------------------------------- 1 | package components 2 | 3 | import "html/template" 4 | 5 | type ChangelogContainerArgs struct { 6 | CurrentURL string 7 | HasMoreArticle bool 8 | } 9 | 10 | // Contains the article list and footer 11 | templ ChangelogContainer(args ChangelogContainerArgs) { 12 |{ args.Subtitle.V() }
30 | } 31 | } 32 | -------------------------------------------------------------------------------- /components/kbd.templ: -------------------------------------------------------------------------------- 1 | package components 2 | 3 | templ KBD(key string) { 4 | 5 | { key } 6 | 7 | } 8 | -------------------------------------------------------------------------------- /components/kbd_templ.go: -------------------------------------------------------------------------------- 1 | // Code generated by templ - DO NOT EDIT. 2 | 3 | // templ: version: v0.2.771 4 | package components 5 | 6 | //lint:file-ignore SA4006 This context is only used if a nested component is present. 7 | 8 | import "github.com/a-h/templ" 9 | import templruntime "github.com/a-h/templ/runtime" 10 | 11 | func KBD(key string) templ.Component { 12 | return templruntime.GeneratedTemplate(func(templ_7745c5c3_Input templruntime.GeneratedComponentInput) (templ_7745c5c3_Err error) { 13 | templ_7745c5c3_W, ctx := templ_7745c5c3_Input.Writer, templ_7745c5c3_Input.Context 14 | templ_7745c5c3_Buffer, templ_7745c5c3_IsBuffer := templruntime.GetBuffer(templ_7745c5c3_W) 15 | if !templ_7745c5c3_IsBuffer { 16 | defer func() { 17 | templ_7745c5c3_BufErr := templruntime.ReleaseBuffer(templ_7745c5c3_Buffer) 18 | if templ_7745c5c3_Err == nil { 19 | templ_7745c5c3_Err = templ_7745c5c3_BufErr 20 | } 21 | }() 22 | } 23 | ctx = templ.InitializeContext(ctx) 24 | templ_7745c5c3_Var1 := templ.GetChildren(ctx) 25 | if templ_7745c5c3_Var1 == nil { 26 | templ_7745c5c3_Var1 = templ.NopComponent 27 | } 28 | ctx = templ.ClearChildren(ctx) 29 | _, templ_7745c5c3_Err = templ_7745c5c3_Buffer.WriteString("") 30 | if templ_7745c5c3_Err != nil { 31 | return templ_7745c5c3_Err 32 | } 33 | var templ_7745c5c3_Var2 string 34 | templ_7745c5c3_Var2, templ_7745c5c3_Err = templ.JoinStringErrs(key) 35 | if templ_7745c5c3_Err != nil { 36 | return templ.Error{Err: templ_7745c5c3_Err, FileName: `components/kbd.templ`, Line: 5, Col: 7} 37 | } 38 | _, templ_7745c5c3_Err = templ_7745c5c3_Buffer.WriteString(templ.EscapeString(templ_7745c5c3_Var2)) 39 | if templ_7745c5c3_Err != nil { 40 | return templ_7745c5c3_Err 41 | } 42 | _, templ_7745c5c3_Err = templ_7745c5c3_Buffer.WriteString("") 43 | if templ_7745c5c3_Err != nil { 44 | return templ_7745c5c3_Err 45 | } 46 | return templ_7745c5c3_Err 47 | }) 48 | } 49 | 50 | var _ = templruntime.GeneratedTemplate 51 | -------------------------------------------------------------------------------- /components/navbar.templ: -------------------------------------------------------------------------------- 1 | package components 2 | 3 | import ( 4 | "github.com/jonashiltl/openchangelog/apitypes" 5 | "github.com/jonashiltl/openchangelog/internal/handler/web/icons" 6 | ) 7 | 8 | type Logo struct { 9 | Src apitypes.NullString 10 | Width apitypes.NullString 11 | Height apitypes.NullString 12 | Alt apitypes.NullString 13 | Link apitypes.NullString 14 | } 15 | 16 | css imgSize(width string, height string) { 17 | width: { width }; 18 | height: { height }; 19 | } 20 | 21 | templ Navbar() { 22 | 27 | } 28 | 29 | templ NavbarActions() { 30 || Name | 28 |Changelogs | 29 |
| { ws.Workspace.Name } | 39 |{ fmt.Sprint(ws.ChangelogCount) } | 40 |
Token: { args.Workspace.Token.String() }
18 |ID: { args.Workspace.ID.String() }
19 || ID | 24 |Title | 25 |Protected | 26 |Subdomain | 27 |Domain | 28 |
| { cl.ID.String() } | 34 |{ cl.Title.V() } | 35 |{ fmt.Sprint(cl.Protected) } | 36 |{ cl.Subdomain.String() } | 37 |{ cl.Domain.String() } | 38 |
{ args.Message }
23 | Try Again 24 |Enter the password to access this changelog.
29 | 46 |{ msg }
59 | } 60 | -------------------------------------------------------------------------------- /internal/handler/web/views/widget.templ: -------------------------------------------------------------------------------- 1 | package views 2 | 3 | import ( 4 | "github.com/jonashiltl/openchangelog/components" 5 | "github.com/jonashiltl/openchangelog/internal/handler/web/views/layout" 6 | ) 7 | 8 | type WidgetArgs struct { 9 | CSS string 10 | components.ChangelogContainerArgs 11 | components.HeaderArgs 12 | components.ArticleListArgs 13 | components.FooterArgs 14 | } 15 | 16 | templ Widget(arg WidgetArgs) { 17 | if arg.CSS != "" { 18 | @layout.InlineCSS(arg.CSS) 19 | } 20 | @components.Prose() { 21 | @components.ChangelogContainer(arg.ChangelogContainerArgs) { 22 | @components.HeaderContainer() { 23 | @components.HeaderContent(arg.HeaderArgs) 24 | } 25 | @components.ArticleList(arg.ArticleListArgs) 26 | } 27 | @components.Footer(arg.FooterArgs) 28 | } 29 | } 30 | 31 | templ WidgetError(err error) { 32 |Error: { err.Error() }
33 | } 34 | -------------------------------------------------------------------------------- /internal/load/loader.go: -------------------------------------------------------------------------------- 1 | package load 2 | 3 | import ( 4 | "context" 5 | "errors" 6 | "log/slog" 7 | "net/http" 8 | 9 | mint "github.com/btvoidx/mint/context" 10 | "github.com/jonashiltl/openchangelog/internal" 11 | "github.com/jonashiltl/openchangelog/internal/config" 12 | "github.com/jonashiltl/openchangelog/internal/errs" 13 | "github.com/jonashiltl/openchangelog/internal/events" 14 | "github.com/jonashiltl/openchangelog/internal/parse" 15 | "github.com/jonashiltl/openchangelog/internal/source" 16 | "github.com/jonashiltl/openchangelog/internal/store" 17 | "github.com/jonashiltl/openchangelog/internal/xcache" 18 | "github.com/jonashiltl/openchangelog/internal/xlog" 19 | ) 20 | 21 | type LoadedChangelog struct { 22 | CL store.Changelog 23 | Notes []parse.ParsedReleaseNote 24 | HasMore bool 25 | } 26 | 27 | // Creates a new Loader. 28 | func NewLoader( 29 | cfg config.Config, 30 | store store.Store, 31 | cache xcache.Cache, 32 | parser parse.Parser, 33 | e *mint.Emitter, 34 | ) *Loader { 35 | return &Loader{ 36 | cfg: cfg, 37 | store: store, 38 | cache: cache, 39 | parser: parser, 40 | e: e, 41 | } 42 | } 43 | 44 | // The loader combines the source and parse package. 45 | // It first loads the raw release notes using the source package and then parses it using the parse package. 46 | type Loader struct { 47 | cfg config.Config 48 | store store.Store 49 | cache xcache.Cache 50 | parser parse.Parser 51 | e *mint.Emitter 52 | } 53 | 54 | // Returns the changelog of the request. 55 | func (l *Loader) GetChangelog(r *http.Request) (store.Changelog, error) { 56 | host := r.Host 57 | if r.Header.Get("X-Forwarded-Host") != "" { 58 | host = r.Header.Get("X-Forwarded-Host") 59 | } 60 | 61 | if l.cfg.IsConfigMode() { 62 | return l.store.GetChangelog(r.Context(), "", "") 63 | } 64 | return l.fromHost(r.Context(), host) 65 | } 66 | 67 | // Loads the changelog and parses it's release notes for the specified http request. 68 | func (l *Loader) LoadAndParse(r *http.Request, page internal.Pagination) (LoadedChangelog, error) { 69 | cl, err := l.GetChangelog(r) 70 | if err != nil { 71 | return LoadedChangelog{}, err 72 | } 73 | 74 | return l.LoadAndParseReleaseNotes(r.Context(), cl, page) 75 | } 76 | 77 | // Loads and parses the release notes for the specified changelog. 78 | func (l *Loader) LoadAndParseReleaseNotes(ctx context.Context, cl store.Changelog, page internal.Pagination) (LoadedChangelog, error) { 79 | s, err := source.NewSourceFromStore(l.cfg, cl, l.cache) 80 | if err != nil { 81 | return LoadedChangelog{}, err 82 | } 83 | 84 | if s != nil { 85 | loaded, err := s.Load(ctx, page) 86 | if err != nil { 87 | return LoadedChangelog{}, err 88 | } 89 | // emit event if release notes have changed 90 | if loaded.HasChanged() { 91 | err = mint.Emit(l.e, ctx, events.SourceContentChanged{ 92 | CL: cl, 93 | Source: s, 94 | }) 95 | if err != nil { 96 | slog.Debug("failed to emit source changed event", xlog.ErrAttr(err)) 97 | } 98 | } 99 | parsed := l.parser.Parse(ctx, loaded.Raw, page) 100 | return LoadedChangelog{ 101 | CL: cl, 102 | Notes: parsed.ReleaseNotes, 103 | HasMore: loaded.HasMore || parsed.HasMore, 104 | }, nil 105 | } 106 | 107 | return LoadedChangelog{CL: cl}, nil 108 | } 109 | 110 | func (l *Loader) fromHost(ctx context.Context, host string) (store.Changelog, error) { 111 | subdomain, err1 := store.SubdomainFromHost(host) 112 | domain, err2 := store.ParseDomain(host) 113 | if err1 != nil && err2 != nil { 114 | return store.Changelog{}, errs.NewBadRequest(errors.New("host & subdomain is not a valid url")) 115 | } 116 | 117 | return l.store.GetChangelogByDomainOrSubdomain(ctx, domain, subdomain) 118 | } 119 | -------------------------------------------------------------------------------- /internal/pagination.go: -------------------------------------------------------------------------------- 1 | package internal 2 | 3 | type Pagination interface { 4 | PageSize() int 5 | Page() int 6 | StartIdx() int 7 | EndIdx() int 8 | // Returns true if the pagination is defined, else false and pagination should be ignored 9 | IsDefined() bool 10 | } 11 | 12 | type pagination struct { 13 | pageSize int 14 | page int 15 | isDefined bool 16 | } 17 | 18 | func NewPagination(pageSize int, page int) Pagination { 19 | return pagination{ 20 | pageSize: pageSize, 21 | page: page, 22 | isDefined: true, 23 | } 24 | } 25 | 26 | func NoPagination() Pagination { 27 | return pagination{ 28 | isDefined: false, 29 | } 30 | } 31 | 32 | func (p pagination) PageSize() int { 33 | return p.pageSize 34 | } 35 | 36 | func (p pagination) Page() int { 37 | return p.page 38 | } 39 | 40 | func (p pagination) StartIdx() int { 41 | return (p.page - 1) * p.pageSize 42 | } 43 | 44 | func (p pagination) EndIdx() int { 45 | return p.page*p.pageSize - 1 46 | } 47 | 48 | func (p pagination) IsDefined() bool { 49 | return p.isDefined 50 | } 51 | -------------------------------------------------------------------------------- /internal/parse/og.go: -------------------------------------------------------------------------------- 1 | package parse 2 | 3 | import ( 4 | "bytes" 5 | "fmt" 6 | "io" 7 | "log/slog" 8 | 9 | "github.com/jonashiltl/openchangelog/internal/xlog" 10 | enclave "github.com/quail-ink/goldmark-enclave" 11 | "github.com/yuin/goldmark" 12 | "github.com/yuin/goldmark/extension" 13 | gmparser "github.com/yuin/goldmark/parser" 14 | "github.com/yuin/goldmark/renderer/html" 15 | "go.abhg.dev/goldmark/frontmatter" 16 | "mvdan.cc/xurls/v2" 17 | ) 18 | 19 | // This is the original parser that expects one markdown file per release note. 20 | // All the meta information should be defined with Frontmatter. 21 | type ogparser struct { 22 | gm goldmark.Markdown 23 | } 24 | 25 | // Creates a new goldmark instance, used to parse Markdown to HTML. 26 | func CreateGoldmark() goldmark.Markdown { 27 | return goldmark.New( 28 | goldmark.WithRendererOptions( 29 | html.WithUnsafe(), 30 | ), 31 | goldmark.WithExtensions( 32 | extension.GFM, 33 | enclave.New(&enclave.Config{}), 34 | &frontmatter.Extender{}, 35 | extension.NewLinkify( 36 | extension.WithLinkifyAllowedProtocols([]string{ 37 | "http:", 38 | "https:", 39 | }), 40 | extension.WithLinkifyURLRegexp( 41 | xurls.Strict(), 42 | ), 43 | ), 44 | ), 45 | ) 46 | } 47 | 48 | func NewOGParser(gm goldmark.Markdown) *ogparser { 49 | return &ogparser{ 50 | gm: gm, 51 | } 52 | } 53 | 54 | // Takes a raw article in our original markdown format and parses it. 55 | func (g *ogparser) parseReleaseNote(article io.Reader) (ParsedReleaseNote, error) { 56 | source, err := io.ReadAll(article) 57 | if err != nil { 58 | return ParsedReleaseNote{}, err 59 | } 60 | 61 | return g.parseReleaseNoteBytes(source) 62 | } 63 | 64 | // Parses the raw article content, but expects a part of the content to be already read (to detect the file format). 65 | func (g *ogparser) parseReleaseNoteRead(read string, rest io.Reader) (ParsedReleaseNote, error) { 66 | source, err := io.ReadAll(rest) 67 | if err != nil { 68 | return ParsedReleaseNote{}, err 69 | } 70 | 71 | full := append([]byte(read), source...) 72 | 73 | return g.parseReleaseNoteBytes(full) 74 | } 75 | 76 | // Don't use diretly, use parseArticle() and parseArticleRead() instead. 77 | func (g *ogparser) parseReleaseNoteBytes(content []byte) (ParsedReleaseNote, error) { 78 | ctx := gmparser.NewContext() 79 | 80 | var target bytes.Buffer 81 | err := g.gm.Convert(content, &target, gmparser.WithContext(ctx)) 82 | if err != nil { 83 | slog.Warn("failed to convert to html", xlog.ErrAttr(err)) 84 | return ParsedReleaseNote{}, err 85 | } 86 | 87 | data := frontmatter.Get(ctx) 88 | if data == nil { 89 | return ParsedReleaseNote{ 90 | Content: &target, 91 | }, nil 92 | } 93 | var meta Meta 94 | err = data.Decode(&meta) 95 | if err != nil { 96 | slog.Warn("failed to parse frontmatter", xlog.ErrAttr(err)) 97 | return ParsedReleaseNote{}, err 98 | } 99 | 100 | meta.ID = fmt.Sprint(meta.PublishedAt.Unix()) 101 | 102 | return ParsedReleaseNote{ 103 | Meta: meta, 104 | Content: &target, 105 | }, nil 106 | } 107 | -------------------------------------------------------------------------------- /internal/parse/og_test.go: -------------------------------------------------------------------------------- 1 | package parse 2 | 3 | import ( 4 | "fmt" 5 | "os" 6 | "reflect" 7 | "testing" 8 | "time" 9 | ) 10 | 11 | func openOGTestData(name string) (*os.File, error) { 12 | file, err := os.Open(fmt.Sprintf("../../.testdata/%s.md", name)) 13 | if err != nil { 14 | return nil, err 15 | } 16 | return file, nil 17 | } 18 | 19 | func TestOGParseArticle(t *testing.T) { 20 | p := NewOGParser(CreateGoldmark()) 21 | file, err := openOGTestData("v0.0.1-commonmark") 22 | if err != nil { 23 | t.Fatal(err) 24 | } 25 | 26 | parsed, err := p.parseReleaseNote(file) 27 | if err != nil { 28 | t.Fatal(err) 29 | } 30 | 31 | expectedTags := []string{"Improvement"} 32 | if !reflect.DeepEqual(parsed.Meta.Tags, expectedTags) { 33 | t.Errorf("Expected %s to equal %s", parsed.Meta.Tags, expectedTags) 34 | } 35 | 36 | expectedTitle := "CommonMark 0.31.2 compliance" 37 | if parsed.Meta.Title != expectedTitle { 38 | t.Errorf("Expected %s to equal %s", parsed.Meta.Title, expectedTitle) 39 | } 40 | 41 | expectedPublishedAt := time.Date(2024, 4, 3, 0, 0, 0, 0, time.UTC) 42 | if parsed.Meta.PublishedAt != expectedPublishedAt { 43 | t.Errorf("Expected %s to equal %s", parsed.Meta.PublishedAt, expectedPublishedAt) 44 | } 45 | } 46 | 47 | func TestOGParseArticleRead(t *testing.T) { 48 | p := NewOGParser(CreateGoldmark()) 49 | file, err := openOGTestData("v0.0.5-beta") 50 | if err != nil { 51 | t.Fatal(err) 52 | } 53 | _, read := detectFileFormat(file) 54 | parsed, err := p.parseReleaseNoteRead(read, file) 55 | if err != nil { 56 | t.Fatal(err) 57 | } 58 | 59 | expectedTags := []string{"Community", "Cloud"} 60 | if !reflect.DeepEqual(parsed.Meta.Tags, expectedTags) { 61 | t.Errorf("Expected %s to equal %s", parsed.Meta.Tags, expectedTags) 62 | } 63 | 64 | expectedTitle := "Open Beta" 65 | if parsed.Meta.Title != expectedTitle { 66 | t.Errorf("Expected %s to equal %s", parsed.Meta.Title, expectedTitle) 67 | } 68 | 69 | expectedPublishedAt := time.Date(2024, 8, 26, 0, 0, 0, 0, time.UTC) 70 | if parsed.Meta.PublishedAt != expectedPublishedAt { 71 | t.Errorf("Expected %s to equal %s", parsed.Meta.PublishedAt, expectedPublishedAt) 72 | } 73 | } 74 | -------------------------------------------------------------------------------- /internal/parse/parser_test.go: -------------------------------------------------------------------------------- 1 | package parse 2 | 3 | import ( 4 | "context" 5 | "fmt" 6 | "os" 7 | "testing" 8 | 9 | "github.com/jonashiltl/openchangelog/internal" 10 | "github.com/jonashiltl/openchangelog/internal/source" 11 | ) 12 | 13 | func TestParse(t *testing.T) { 14 | p := NewParser(CreateGoldmark()) 15 | tables := []struct { 16 | name string 17 | files []string 18 | page internal.Pagination 19 | expectedHasMore bool 20 | expectedArticleLength int 21 | }{ 22 | { 23 | name: "OG one", 24 | files: []string{"v0.0.1-commonmark.md"}, 25 | page: internal.NoPagination(), 26 | expectedHasMore: false, 27 | expectedArticleLength: 1, 28 | }, 29 | { 30 | name: "OG multiple", 31 | files: []string{"v0.0.1-commonmark.md", "v0.0.2-open-source.md", "v0.0.5-beta.md"}, 32 | page: internal.NoPagination(), 33 | expectedHasMore: false, 34 | expectedArticleLength: 3, 35 | }, 36 | { 37 | name: "OG pagination not used", 38 | files: []string{"v0.0.1-commonmark.md", "v0.0.2-open-source.md", "v0.0.5-beta.md"}, 39 | page: internal.NewPagination(2, 1), 40 | expectedHasMore: false, 41 | expectedArticleLength: 3, 42 | }, 43 | { 44 | name: "Keepachangelog no pagination", 45 | files: []string{"keepachangelog/minimal.md"}, 46 | page: internal.NoPagination(), 47 | expectedHasMore: false, 48 | expectedArticleLength: 1, 49 | }, 50 | { 51 | name: "Keepachangelog full no pagination", 52 | files: []string{"keepachangelog/full.md"}, 53 | page: internal.NoPagination(), 54 | expectedHasMore: false, 55 | expectedArticleLength: 15, 56 | }, 57 | { 58 | name: "Keepachangelog full paginated", 59 | files: []string{"keepachangelog/full.md"}, 60 | page: internal.NewPagination(4, 2), 61 | expectedHasMore: true, 62 | expectedArticleLength: 4, 63 | }, 64 | } 65 | 66 | for _, table := range tables { 67 | t.Run(table.name, func(t *testing.T) { 68 | notes := make([]source.RawReleaseNote, 0, len(table.files)) 69 | for _, file := range table.files { 70 | content, err := os.Open(fmt.Sprintf("../../.testdata/%s", file)) 71 | if err != nil { 72 | t.Fatal(err) 73 | } 74 | notes = append(notes, source.RawReleaseNote{Content: content}) 75 | } 76 | 77 | parsed := p.Parse(context.Background(), notes, table.page) 78 | if len(parsed.ReleaseNotes) != table.expectedArticleLength { 79 | t.Errorf("Expected article length %d but got %d", table.expectedArticleLength, len(parsed.ReleaseNotes)) 80 | } 81 | if parsed.HasMore != table.expectedHasMore { 82 | t.Errorf("Expected hasMore %t but got %t", table.expectedHasMore, parsed.HasMore) 83 | } 84 | }) 85 | } 86 | } 87 | -------------------------------------------------------------------------------- /internal/parse/utils.go: -------------------------------------------------------------------------------- 1 | package parse 2 | 3 | import ( 4 | "bytes" 5 | "io" 6 | ) 7 | 8 | type FileFormat int 9 | 10 | const ( 11 | OG FileFormat = iota 12 | KeepAChangelog 13 | ) 14 | 15 | // Detects the file format of r and returns the string read to detect the file format. 16 | // The read string can not be read again from r. 17 | func detectFileFormat(r io.Reader) (FileFormat, string) { 18 | var buf bytes.Buffer 19 | _, err := io.CopyN(&buf, r, 3) 20 | if err != nil { 21 | return OG, "" 22 | } 23 | start := buf.String() 24 | if start == "---" { 25 | // if content has frontmatter => it's probably our own file format 26 | return OG, start 27 | } 28 | return KeepAChangelog, start 29 | } 30 | 31 | // Sorts ParsedArticles by their published date. 32 | func sortArticleDesc(a ParsedReleaseNote, b ParsedReleaseNote) int { 33 | if a.Meta.PublishedAt.IsZero() && b.Meta.PublishedAt.IsZero() { 34 | return 0 35 | } 36 | if a.Meta.PublishedAt.IsZero() { 37 | return -1 38 | } 39 | if b.Meta.PublishedAt.IsZero() { 40 | return 1 41 | } 42 | 43 | if a.Meta.PublishedAt.After(b.Meta.PublishedAt) { 44 | return -1 45 | } 46 | 47 | return 1 48 | } 49 | -------------------------------------------------------------------------------- /internal/parse/utils_test.go: -------------------------------------------------------------------------------- 1 | package parse 2 | 3 | import ( 4 | "io" 5 | "slices" 6 | "strings" 7 | "testing" 8 | "time" 9 | ) 10 | 11 | func TestSortArticleDesc(t *testing.T) { 12 | tables := []struct { 13 | name string 14 | a time.Time 15 | b time.Time 16 | aFirst bool 17 | }{ 18 | { 19 | name: "a zero", 20 | b: time.Now(), 21 | aFirst: true, 22 | }, 23 | { 24 | name: "b zero", 25 | a: time.Now(), 26 | aFirst: false, 27 | }, 28 | { 29 | name: "a earlier", 30 | a: time.Date(2024, 10, 20, 0, 0, 0, 0, time.UTC), 31 | b: time.Date(2024, 10, 19, 0, 0, 0, 0, time.UTC), 32 | aFirst: true, 33 | }, 34 | { 35 | name: "b earlier", 36 | a: time.Date(2024, 10, 19, 0, 0, 0, 0, time.UTC), 37 | b: time.Date(2024, 10, 20, 0, 0, 0, 0, time.UTC), 38 | }, 39 | } 40 | 41 | for _, table := range tables { 42 | t.Run(table.name, func(t *testing.T) { 43 | 44 | slice := []ParsedReleaseNote{ 45 | {Meta: Meta{Title: "a", PublishedAt: table.a}}, 46 | {Meta: Meta{Title: "b", PublishedAt: table.b}}, 47 | } 48 | slices.SortFunc(slice, sortArticleDesc) 49 | 50 | aFirst := slice[0].Meta.Title == "a" 51 | if aFirst != table.aFirst { 52 | t.Error("Expected a to be first but got b") 53 | } 54 | }) 55 | } 56 | } 57 | 58 | func TestDetectFileFormat(t *testing.T) { 59 | testCases := []struct { 60 | name string 61 | file string 62 | expected FileFormat 63 | }{ 64 | { 65 | name: "OG format with frontmatter", 66 | file: "---\ntitle: Test\n---", 67 | expected: OG, 68 | }, 69 | { 70 | name: "KeepAChangelog format", 71 | file: "# Changelog", 72 | expected: KeepAChangelog, 73 | }, 74 | { 75 | name: "Empty line", 76 | file: "", 77 | expected: OG, 78 | }, 79 | { 80 | name: "Line without frontmatter", 81 | file: "This is a regular line", 82 | expected: KeepAChangelog, 83 | }, 84 | } 85 | 86 | for _, tc := range testCases { 87 | t.Run(tc.name, func(t *testing.T) { 88 | r := strings.NewReader(tc.file) 89 | result, read := detectFileFormat(r) 90 | if result != tc.expected { 91 | t.Errorf("Expected %v, but got %v", tc.expected, result) 92 | } 93 | 94 | rest, _ := io.ReadAll(r) 95 | expectedRest, _ := strings.CutPrefix(tc.file, read) 96 | if string(rest) != expectedRest { 97 | t.Errorf("Expected rest=%q got=%q", expectedRest, string(rest)) 98 | } 99 | }) 100 | } 101 | } 102 | -------------------------------------------------------------------------------- /internal/search/noop.go: -------------------------------------------------------------------------------- 1 | package search 2 | 3 | import "context" 4 | 5 | func NewNoopSearcher() Searcher { 6 | return noopSearcher{} 7 | } 8 | 9 | type noopSearcher struct{} 10 | 11 | func (s noopSearcher) Close() { 12 | 13 | } 14 | 15 | func (s noopSearcher) Index(context.Context, IndexArgs) error { 16 | return nil 17 | } 18 | 19 | func (s noopSearcher) BatchIndex(context.Context, BatchIndexArgs) error { 20 | return nil 21 | } 22 | 23 | func (s noopSearcher) Search(context.Context, SearchArgs) (SearchResults, error) { 24 | return SearchResults{}, nil 25 | } 26 | 27 | func (s noopSearcher) GetAllTags(ctx context.Context, sid string) []string { 28 | return []string{} 29 | } 30 | 31 | func (s noopSearcher) BatchRemove(ctx context.Context, args BatchRemoveArgs) error { 32 | return nil 33 | } 34 | -------------------------------------------------------------------------------- /internal/source/source.go: -------------------------------------------------------------------------------- 1 | package source 2 | 3 | import ( 4 | "context" 5 | "errors" 6 | "io" 7 | 8 | "github.com/jonashiltl/openchangelog/internal" 9 | "github.com/jonashiltl/openchangelog/internal/config" 10 | "github.com/jonashiltl/openchangelog/internal/store" 11 | "github.com/jonashiltl/openchangelog/internal/xcache" 12 | ) 13 | 14 | type RawReleaseNote struct { 15 | Content io.Reader 16 | hasChanged bool // only available if caching is enabled 17 | } 18 | 19 | type LoadResult struct { 20 | Raw []RawReleaseNote 21 | HasMore bool 22 | } 23 | 24 | // Returns if any of the loaded release notes have changed since last access. 25 | func (r LoadResult) HasChanged() bool { 26 | for _, note := range r.Raw { 27 | if note.hasChanged { 28 | return true 29 | } 30 | } 31 | return false 32 | } 33 | 34 | // A source can be used to load raw release notes from a (remote) source like GitHub. 35 | type Source interface { 36 | Load(ctx context.Context, page internal.Pagination) (LoadResult, error) 37 | ID() ID 38 | } 39 | 40 | // A unique identifier for a source 41 | type ID string 42 | 43 | func (i ID) String() string { 44 | return string(i) 45 | } 46 | 47 | func NewIDFromChangelog(cl store.Changelog) ID { 48 | if cl.LocalSource.Valid { 49 | return NewLocalID(cl.LocalSource.V.Path) 50 | } else if cl.GHSource.Valid { 51 | return NewGitHubID(cl.GHSource.V.Owner, cl.GHSource.V.Repo, cl.GHSource.V.Path) 52 | } 53 | return "" 54 | } 55 | 56 | func NewSourceFromStore(cfg config.Config, cl store.Changelog, cache xcache.Cache) (Source, error) { 57 | if cl.LocalSource.Valid { 58 | return NewLocalSourceFromStore(cl.LocalSource.ValueOrZero(), cache), nil 59 | } else if cl.GHSource.Valid { 60 | return NewGHSourceFromStore(cfg, cl.GHSource.ValueOrZero(), cache) 61 | } 62 | return nil, errors.New("changelog has no active source") 63 | } 64 | -------------------------------------------------------------------------------- /internal/store/color_scheme.go: -------------------------------------------------------------------------------- 1 | package store 2 | 3 | import ( 4 | "database/sql/driver" 5 | "errors" 6 | "fmt" 7 | 8 | "github.com/jonashiltl/openchangelog/apitypes" 9 | ) 10 | 11 | type ColorScheme int 12 | 13 | const ( 14 | System ColorScheme = 1 15 | Light ColorScheme = 2 16 | Dark ColorScheme = 3 17 | ) 18 | 19 | func NewColorScheme(cs apitypes.ColorScheme) ColorScheme { 20 | switch cs { 21 | case apitypes.System: 22 | return System 23 | case apitypes.Dark: 24 | return Dark 25 | case apitypes.Light: 26 | return Light 27 | } 28 | return 0 29 | } 30 | 31 | func (cs ColorScheme) String() string { 32 | switch cs { 33 | case System: 34 | return "system" 35 | case Light: 36 | return "light" 37 | case Dark: 38 | return "dark" 39 | } 40 | return "unkown" 41 | } 42 | 43 | func (cs ColorScheme) ToApiTypes() apitypes.ColorScheme { 44 | switch cs { 45 | case System: 46 | return apitypes.System 47 | case Dark: 48 | return apitypes.Dark 49 | case Light: 50 | return apitypes.Light 51 | } 52 | return apitypes.System 53 | } 54 | 55 | func (cs *ColorScheme) Scan(value interface{}) error { 56 | i, ok := value.(int64) 57 | if !ok { 58 | return errors.New("ColorScheme.Scan: value is not an int64") 59 | } 60 | 61 | switch ColorScheme(i) { 62 | case System, Light, Dark: 63 | *cs = ColorScheme(i) 64 | return nil 65 | default: 66 | return fmt.Errorf("ColorScheme.Scan: failed to scan %d", i) 67 | } 68 | } 69 | 70 | func (cs ColorScheme) Value() (driver.Value, error) { 71 | return int64(cs), nil 72 | } 73 | -------------------------------------------------------------------------------- /internal/store/color_scheme_test.go: -------------------------------------------------------------------------------- 1 | package store 2 | 3 | import ( 4 | "testing" 5 | ) 6 | 7 | func TestColorSchemeValue(t *testing.T) { 8 | tests := []struct { 9 | scheme ColorScheme 10 | expected int64 11 | }{ 12 | { 13 | scheme: Dark, 14 | expected: 3, 15 | }, 16 | { 17 | scheme: Light, 18 | expected: 2, 19 | }, 20 | { 21 | scheme: System, 22 | expected: 1, 23 | }, 24 | } 25 | 26 | for _, test := range tests { 27 | t.Run(test.scheme.String(), func(t *testing.T) { 28 | v, err := test.scheme.Value() 29 | if err != nil { 30 | t.Error(err) 31 | } 32 | if v.(int64) != test.expected { 33 | t.Errorf("Expected %d to equal %d", v, test.expected) 34 | } 35 | }) 36 | } 37 | } 38 | 39 | func TestColorSchemeScan(t *testing.T) { 40 | schemes := []ColorScheme{ 41 | System, Dark, Light, 42 | } 43 | 44 | for _, input := range schemes { 45 | t.Run(input.String(), func(t *testing.T) { 46 | v, err := input.Value() 47 | if err != nil { 48 | t.Error(err) 49 | } 50 | 51 | var scanned ColorScheme 52 | err = scanned.Scan(v) 53 | if err != nil { 54 | t.Error(err) 55 | } 56 | 57 | if scanned != input { 58 | t.Errorf("Expected %s to equal %s", scanned, input) 59 | } 60 | }) 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /internal/store/db.go: -------------------------------------------------------------------------------- 1 | // Code generated by sqlc. DO NOT EDIT. 2 | // versions: 3 | // sqlc v1.26.0 4 | 5 | package store 6 | 7 | import ( 8 | "context" 9 | "database/sql" 10 | ) 11 | 12 | type DBTX interface { 13 | ExecContext(context.Context, string, ...interface{}) (sql.Result, error) 14 | PrepareContext(context.Context, string) (*sql.Stmt, error) 15 | QueryContext(context.Context, string, ...interface{}) (*sql.Rows, error) 16 | QueryRowContext(context.Context, string, ...interface{}) *sql.Row 17 | } 18 | 19 | func New(db DBTX) *Queries { 20 | return &Queries{db: db} 21 | } 22 | 23 | type Queries struct { 24 | db DBTX 25 | } 26 | 27 | func (q *Queries) WithTx(tx *sql.Tx) *Queries { 28 | return &Queries{ 29 | db: tx, 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /internal/store/domain.go: -------------------------------------------------------------------------------- 1 | package store 2 | 3 | import ( 4 | "errors" 5 | "fmt" 6 | "net/url" 7 | "regexp" 8 | "strings" 9 | 10 | "github.com/gosimple/slug" 11 | "github.com/jonashiltl/openchangelog/apitypes" 12 | "github.com/jonashiltl/openchangelog/internal/errs" 13 | "github.com/sio/coolname" 14 | "golang.org/x/exp/rand" 15 | ) 16 | 17 | type Domain apitypes.NullString 18 | 19 | func (d Domain) String() string { 20 | return d.NullString().V() 21 | } 22 | 23 | func (d Domain) NullString() apitypes.NullString { 24 | return apitypes.NullString(d) 25 | } 26 | 27 | var errInvalidDomain = errs.NewBadRequest(errors.New("domain is not valid")) 28 | 29 | // strips everything from domain except the host 30 | func ParseDomain(domain string) (Domain, error) { 31 | if !strings.Contains(domain, ".") { 32 | return Domain{}, errInvalidDomain 33 | } 34 | if !strings.Contains(domain, "://") { 35 | domain = "http://" + domain // Add a default scheme, else host is empty 36 | } 37 | 38 | parsedUrl, err := url.Parse(domain) 39 | if err != nil { 40 | return Domain{}, errInvalidDomain 41 | } 42 | 43 | domain = parsedUrl.Host 44 | return Domain(apitypes.NewString(domain)), nil 45 | } 46 | 47 | // if ns is valid, it parses the domain by stripping everything except the host from the string. 48 | func ParseDomainNullString(ns apitypes.NullString) (Domain, error) { 49 | if !ns.IsValid() { 50 | return Domain(ns), nil 51 | } 52 | return ParseDomain(ns.V()) 53 | } 54 | 55 | type Subdomain string 56 | 57 | func (s Subdomain) String() string { 58 | return string(s) 59 | } 60 | 61 | func (s Subdomain) NullString() apitypes.NullString { 62 | return apitypes.NewString(s.String()) 63 | } 64 | 65 | func NewSubdomain(workspaceName string) Subdomain { 66 | suffix, err := coolname.SlugN(2) 67 | if err != nil { 68 | suffix = fmt.Sprint(rand.Intn(100000)) 69 | } 70 | 71 | subdomain := slug.Make(fmt.Sprintf("%s %s", workspaceName, suffix)) 72 | return Subdomain(subdomain) 73 | } 74 | 75 | var subdomainRegex = regexp.MustCompile("^[a-z0-9-]*$") 76 | 77 | // Returns the subdomain from the host. 78 | // Returns an error if the host doesn't have a subdomain 79 | func SubdomainFromHost(host string) (Subdomain, error) { 80 | // add scheme, else parsed url won't include host 81 | if !strings.Contains(host, "://") { 82 | host = "https://" + host 83 | } 84 | 85 | parsedURL, err := url.Parse(host) 86 | if err != nil { 87 | return "", errs.NewBadRequest(errors.New("invalid URL")) 88 | } 89 | 90 | // Extract the host from the parsed URL 91 | host = parsedURL.Host 92 | parts := strings.Split(host, ".") 93 | if parts[0] == "www" { 94 | parts = parts[1:] 95 | } 96 | 97 | // subdomain exists, e.g. tenant.openchangelog.com 98 | if len(parts) > 2 { 99 | if !subdomainRegex.MatchString(parts[0]) { 100 | return "", errs.NewBadRequest(errors.New("subdomain not valid")) 101 | } 102 | return Subdomain(parts[0]), nil 103 | } 104 | return "", errs.NewBadRequest(errors.New("host has no subdomain")) 105 | } 106 | -------------------------------------------------------------------------------- /internal/store/domain_test.go: -------------------------------------------------------------------------------- 1 | package store 2 | 3 | import ( 4 | "testing" 5 | 6 | "github.com/jonashiltl/openchangelog/apitypes" 7 | ) 8 | 9 | func TestParseDomain(t *testing.T) { 10 | tables := []struct { 11 | host string 12 | expected apitypes.NullString 13 | expectErr bool 14 | }{ 15 | 16 | { 17 | host: "openchangelog.com", 18 | expected: apitypes.NewString("openchangelog.com"), 19 | }, 20 | { 21 | host: "changelog.openchangelog.com", 22 | expected: apitypes.NewString("changelog.openchangelog.com"), 23 | }, 24 | { 25 | host: "changelog.openchangelog.com:3000", 26 | expected: apitypes.NewString("changelog.openchangelog.com:3000"), 27 | }, 28 | { 29 | host: "https://changelog.openchangelog.com", 30 | expected: apitypes.NewString("changelog.openchangelog.com"), 31 | }, 32 | { 33 | host: "http://changelog.openchangelog.com", 34 | expected: apitypes.NewString("changelog.openchangelog.com"), 35 | }, 36 | { 37 | host: "https://test com", 38 | expectErr: true, 39 | }, 40 | { 41 | host: "openchangelog", 42 | expectErr: true, 43 | }, 44 | } 45 | 46 | for _, table := range tables { 47 | t.Run(table.host, func(t *testing.T) { 48 | d, err := ParseDomain(table.host) 49 | if table.expectErr && err == nil { 50 | t.Error("expected to error but no error returned") 51 | } 52 | if d.String() != table.expected.V() { 53 | t.Errorf("expected %s to equal %s", d.String(), table.expected.V()) 54 | } 55 | }) 56 | } 57 | } 58 | 59 | func TestParseSubdomain(t *testing.T) { 60 | tables := []struct { 61 | host string 62 | subdomain string 63 | }{ 64 | { 65 | host: "tenant.openchangelog.com", 66 | subdomain: "tenant", 67 | }, 68 | { 69 | host: "tenant-2.openchangelog.com", 70 | subdomain: "tenant-2", 71 | }, 72 | { 73 | host: "https://changelog.test.com", 74 | subdomain: "changelog", 75 | }, 76 | { 77 | host: "https://changelog.test.com:6001", 78 | subdomain: "changelog", 79 | }, 80 | { 81 | host: "openchangelog.com", 82 | subdomain: "", 83 | }, 84 | { 85 | host: "www.openchangelog.com", 86 | subdomain: "", 87 | }, 88 | { 89 | host: "", 90 | subdomain: "", 91 | }, 92 | { 93 | host: ".", 94 | subdomain: "", 95 | }, 96 | { 97 | host: ".com", 98 | subdomain: "", 99 | }, 100 | } 101 | 102 | for _, table := range tables { 103 | t.Run(table.host, func(t *testing.T) { 104 | s, _ := SubdomainFromHost(table.host) 105 | if table.subdomain != s.String() { 106 | t.Fatalf("expected %s to equal %s", s, table.subdomain) 107 | } 108 | }) 109 | } 110 | } 111 | -------------------------------------------------------------------------------- /internal/store/id.go: -------------------------------------------------------------------------------- 1 | package store 2 | 3 | import ( 4 | "errors" 5 | "strings" 6 | 7 | "github.com/jonashiltl/openchangelog/internal/errs" 8 | "github.com/rs/xid" 9 | ) 10 | 11 | const ( 12 | wid_prefix = "ws" 13 | cid_prefix = "cl" 14 | ghid_prefix = "gh" 15 | id_separator = "_" 16 | ) 17 | 18 | type WorkspaceID string 19 | 20 | func NewWID() WorkspaceID { 21 | return WorkspaceID(wid_prefix + id_separator + xid.New().String()) 22 | } 23 | 24 | var errWSFormat = errs.NewError(errs.ErrBadRequest, errors.New("wrong workspace id format")) 25 | 26 | func ParseWID(id string) (WorkspaceID, error) { 27 | if id == WS_DEFAULT_ID.String() { 28 | return WS_DEFAULT_ID, nil 29 | } 30 | 31 | parts := strings.Split(id, id_separator) 32 | if len(parts) != 2 { 33 | return "", errWSFormat 34 | } 35 | if parts[0] != wid_prefix { 36 | return "", errs.NewError(errs.ErrBadRequest, errors.New("invalid workspace id prefix")) 37 | } 38 | _, err := xid.FromString(parts[1]) 39 | if err != nil { 40 | return "", errWSFormat 41 | } 42 | return WorkspaceID(id), nil 43 | } 44 | 45 | func (i WorkspaceID) String() string { 46 | return string(i) 47 | } 48 | 49 | type ChangelogID string 50 | 51 | func NewCID() ChangelogID { 52 | return ChangelogID(cid_prefix + id_separator + xid.New().String()) 53 | } 54 | 55 | var errCLFormat = errs.NewError(errs.ErrBadRequest, errors.New("wrong changelog id format")) 56 | 57 | func ParseCID(id string) (ChangelogID, error) { 58 | if id == CL_DEFAULT_ID.String() { 59 | return CL_DEFAULT_ID, nil 60 | } 61 | parts := strings.Split(id, id_separator) 62 | if len(parts) != 2 { 63 | return "", errCLFormat 64 | } 65 | if parts[0] != cid_prefix { 66 | return "", errs.NewError(errs.ErrBadRequest, errors.New("invalid changelog id prefix")) 67 | } 68 | _, err := xid.FromString(parts[1]) 69 | if err != nil { 70 | return "", errCLFormat 71 | } 72 | return ChangelogID(id), nil 73 | } 74 | 75 | func (i ChangelogID) String() string { 76 | return string(i) 77 | } 78 | 79 | type GHSourceID string 80 | 81 | func NewGHID() GHSourceID { 82 | return GHSourceID(ghid_prefix + id_separator + xid.New().String()) 83 | } 84 | 85 | var errGHFormat = errs.NewError(errs.ErrBadRequest, errors.New("wrong github source id format")) 86 | 87 | func ParseGHID(id string) (GHSourceID, error) { 88 | if id == GH_DEFAULT_ID.String() { 89 | return GH_DEFAULT_ID, nil 90 | } 91 | parts := strings.Split(id, id_separator) 92 | if len(parts) != 2 { 93 | return "", errGHFormat 94 | } 95 | if parts[0] != ghid_prefix { 96 | return "", errs.NewError(errs.ErrBadRequest, errors.New("invalid gh source id prefix")) 97 | } 98 | _, err := xid.FromString(parts[1]) 99 | if err != nil { 100 | return "", errGHFormat 101 | } 102 | return GHSourceID(id), nil 103 | } 104 | 105 | func IsGHID(id string) bool { 106 | return strings.HasPrefix(id, ghid_prefix+id_separator) 107 | } 108 | 109 | func (i GHSourceID) String() string { 110 | return string(i) 111 | } 112 | -------------------------------------------------------------------------------- /internal/store/models.go: -------------------------------------------------------------------------------- 1 | // Code generated by sqlc. DO NOT EDIT. 2 | // versions: 3 | // sqlc v1.26.0 4 | 5 | package store 6 | 7 | import ( 8 | "database/sql" 9 | 10 | "github.com/jonashiltl/openchangelog/apitypes" 11 | ) 12 | 13 | type changelog struct { 14 | ID string 15 | WorkspaceID string 16 | Subdomain string 17 | Title apitypes.NullString 18 | Subtitle apitypes.NullString 19 | SourceID apitypes.NullString 20 | LogoSrc apitypes.NullString 21 | LogoLink apitypes.NullString 22 | LogoAlt apitypes.NullString 23 | LogoHeight apitypes.NullString 24 | LogoWidth apitypes.NullString 25 | CreatedAt int64 26 | Domain apitypes.NullString 27 | ColorScheme ColorScheme 28 | HidePoweredBy int64 29 | Protected int64 30 | PasswordHash apitypes.NullString 31 | Analytics int64 32 | Searchable int64 33 | } 34 | 35 | type changelogSource struct { 36 | ID apitypes.NullString 37 | WorkspaceID apitypes.NullString 38 | Owner apitypes.NullString 39 | Repo apitypes.NullString 40 | Path apitypes.NullString 41 | InstallationID sql.NullInt64 42 | } 43 | 44 | type ghSource struct { 45 | ID string 46 | WorkspaceID string 47 | Owner string 48 | Repo string 49 | Path string 50 | InstallationID int64 51 | } 52 | 53 | type token struct { 54 | Key string 55 | WorkspaceID string 56 | } 57 | 58 | type workspace struct { 59 | ID string 60 | Name string 61 | } 62 | -------------------------------------------------------------------------------- /internal/store/store.go: -------------------------------------------------------------------------------- 1 | package store 2 | 3 | import ( 4 | "context" 5 | "time" 6 | 7 | "github.com/jonashiltl/openchangelog/apitypes" 8 | _ "github.com/mattn/go-sqlite3" 9 | 10 | "github.com/guregu/null/v5" 11 | ) 12 | 13 | type Changelog struct { 14 | WorkspaceID WorkspaceID 15 | ID ChangelogID 16 | Subdomain Subdomain 17 | Domain Domain 18 | Title apitypes.NullString 19 | Subtitle apitypes.NullString 20 | LogoSrc apitypes.NullString 21 | LogoLink apitypes.NullString 22 | LogoAlt apitypes.NullString 23 | LogoHeight apitypes.NullString 24 | LogoWidth apitypes.NullString 25 | ColorScheme ColorScheme 26 | Analytics bool 27 | HidePoweredBy bool 28 | Protected bool 29 | Searchable bool 30 | PasswordHash string 31 | CreatedAt time.Time 32 | GHSource null.Value[GHSource] 33 | LocalSource null.Value[LocalSource] 34 | } 35 | 36 | type Workspace struct { 37 | ID WorkspaceID 38 | Name string 39 | Token Token 40 | } 41 | 42 | type GHSource struct { 43 | ID GHSourceID 44 | WorkspaceID WorkspaceID 45 | Owner string 46 | Repo string 47 | Path string 48 | InstallationID int64 49 | } 50 | 51 | type LocalSource struct { 52 | Path string 53 | } 54 | 55 | type UpdateChangelogArgs struct { 56 | Title apitypes.NullString 57 | Subdomain apitypes.NullString 58 | Domain Domain 59 | Subtitle apitypes.NullString 60 | LogoSrc apitypes.NullString 61 | LogoLink apitypes.NullString 62 | LogoAlt apitypes.NullString 63 | LogoHeight apitypes.NullString 64 | LogoWidth apitypes.NullString 65 | ColorScheme ColorScheme 66 | HidePoweredBy *bool 67 | Protected *bool 68 | Analytics *bool 69 | Searchable *bool 70 | PasswordHash apitypes.NullString 71 | } 72 | 73 | type WorkspaceChangelogCount struct { 74 | Workspace Workspace 75 | ChangelogCount int64 76 | } 77 | 78 | type Store interface { 79 | GetChangelog(context.Context, WorkspaceID, ChangelogID) (Changelog, error) 80 | GetChangelogByDomainOrSubdomain(ctx context.Context, domain Domain, subdomain Subdomain) (Changelog, error) 81 | ListChangelogs(context.Context, WorkspaceID) ([]Changelog, error) 82 | CreateChangelog(context.Context, Changelog) (Changelog, error) 83 | UpdateChangelog(context.Context, WorkspaceID, ChangelogID, UpdateChangelogArgs) (Changelog, error) 84 | DeleteChangelog(context.Context, WorkspaceID, ChangelogID) error 85 | SetChangelogGHSource(context.Context, WorkspaceID, ChangelogID, GHSourceID) error 86 | DeleteChangelogSource(context.Context, WorkspaceID, ChangelogID) error 87 | 88 | // Workspace 89 | GetWorkspace(context.Context, WorkspaceID) (Workspace, error) 90 | SaveWorkspace(context.Context, Workspace) (Workspace, error) 91 | GetWorkspaceIDByToken(ctx context.Context, token string) (WorkspaceID, error) 92 | DeleteWorkspace(context.Context, WorkspaceID) error 93 | 94 | // admin only methods 95 | ListWorkspacesChangelogCount(context.Context) ([]WorkspaceChangelogCount, error) 96 | 97 | // Source 98 | CreateGHSource(context.Context, GHSource) (GHSource, error) 99 | GetGHSource(context.Context, WorkspaceID, GHSourceID) (GHSource, error) 100 | ListGHSources(context.Context, WorkspaceID) ([]GHSource, error) 101 | DeleteGHSource(context.Context, WorkspaceID, GHSourceID) error 102 | } 103 | -------------------------------------------------------------------------------- /internal/store/token.go: -------------------------------------------------------------------------------- 1 | package store 2 | 3 | import ( 4 | "crypto/md5" 5 | "encoding/hex" 6 | "errors" 7 | "strings" 8 | 9 | "github.com/jonashiltl/openchangelog/internal/errs" 10 | "github.com/rs/xid" 11 | ) 12 | 13 | const ( 14 | token_prefix = "tkn" 15 | ) 16 | 17 | type Token string 18 | 19 | func NewToken() Token { 20 | id := xid.New() 21 | hasher := md5.New() 22 | hasher.Write(id.Bytes()) 23 | 24 | return Token("tkn_" + hex.EncodeToString(hasher.Sum(nil))) 25 | } 26 | 27 | var errKeyFormat = errs.NewError(errs.ErrBadRequest, errors.New("wrong token key format")) 28 | 29 | func ParseToken(key string) (Token, error) { 30 | parts := strings.Split(key, id_separator) 31 | if len(parts) != 2 { 32 | return "", errKeyFormat 33 | } 34 | if parts[0] != token_prefix { 35 | return "", errs.NewError(errs.ErrBadRequest, errors.New("invalid token key prefix")) 36 | } 37 | _, err := xid.FromString(parts[1]) 38 | if err != nil { 39 | return "", errKeyFormat 40 | } 41 | return Token(key), nil 42 | } 43 | 44 | func (k Token) String() string { 45 | return string(k) 46 | } 47 | 48 | func (k Token) IsSet() bool { 49 | return string(k) != "" 50 | } 51 | -------------------------------------------------------------------------------- /internal/xcache/cache.go: -------------------------------------------------------------------------------- 1 | package xcache 2 | 3 | import ( 4 | "github.com/gregjones/httpcache" 5 | "github.com/gregjones/httpcache/diskcache" 6 | "github.com/jonashiltl/openchangelog/internal/config" 7 | "github.com/peterbourgon/diskv" 8 | "github.com/sourcegraph/s3cache" 9 | ) 10 | 11 | type Cache = httpcache.Cache 12 | 13 | func NewS3Cache(bucket string) httpcache.Cache { 14 | return s3cache.New(bucket) 15 | } 16 | 17 | func NewDiskCache(cfg config.Config) httpcache.Cache { 18 | return diskcache.NewWithDiskv(diskv.New(diskv.Options{ 19 | BasePath: cfg.Cache.Disk.Location, 20 | CacheSizeMax: cfg.Cache.Disk.MaxSize, // bytes 21 | })) 22 | } 23 | 24 | func NewMemoryCache() httpcache.Cache { 25 | return httpcache.NewMemoryCache() 26 | } 27 | -------------------------------------------------------------------------------- /internal/xlog/log.go: -------------------------------------------------------------------------------- 1 | package xlog 2 | 3 | import ( 4 | "context" 5 | "log/slog" 6 | "net/http" 7 | "time" 8 | 9 | "github.com/rs/xid" 10 | ) 11 | 12 | type contextKey string 13 | 14 | func (c contextKey) String() string { 15 | return "handler context key " + string(c) 16 | } 17 | 18 | var ( 19 | ctxKeyRequestID = contextKey("request-id") 20 | ctxKeyWorkspaceID = contextKey("workspace-id") 21 | ctxKeyRequestPath = contextKey("request-path") 22 | ctxKeyRequestMethod = contextKey("request-method") 23 | ctxKeyRequestStart = contextKey("request-start") 24 | ctxKeyRequestHost = contextKey("request-host") 25 | ) 26 | 27 | // Attaches logger attributes to the handler. 28 | func AttachLogger(fn http.HandlerFunc) http.HandlerFunc { 29 | return func(w http.ResponseWriter, r *http.Request) { 30 | addRequestID(r) 31 | addRequestPath(r) 32 | addRequestMethod(r) 33 | addRequestStart(r) 34 | addHost(r) 35 | fn(w, r) 36 | } 37 | } 38 | 39 | // Attaches a workspace to the request context. 40 | // Useful for logging. 41 | func AddWorkspaceID(r *http.Request, id string) { 42 | *r = *r.WithContext(context.WithValue(r.Context(), ctxKeyWorkspaceID, id)) 43 | } 44 | 45 | func addRequestID(r *http.Request) { 46 | id := r.Header.Get("X-Request-ID") 47 | if id == "" { 48 | id = xid.New().String() 49 | } 50 | *r = *r.WithContext(context.WithValue(r.Context(), ctxKeyRequestID, id)) 51 | } 52 | 53 | func addRequestPath(r *http.Request) { 54 | *r = *r.WithContext(context.WithValue(r.Context(), ctxKeyRequestPath, r.URL.String())) 55 | } 56 | 57 | func addRequestMethod(r *http.Request) { 58 | *r = *r.WithContext(context.WithValue(r.Context(), ctxKeyRequestMethod, r.Method)) 59 | } 60 | 61 | func addRequestStart(r *http.Request) { 62 | *r = *r.WithContext(context.WithValue(r.Context(), ctxKeyRequestStart, time.Now())) 63 | } 64 | 65 | func addHost(r *http.Request) { 66 | host := r.Host 67 | if r.Header.Get("X-Forwarded-Host") != "" { 68 | host = r.Header.Get("X-Forwarded-Host") 69 | } 70 | *r = *r.WithContext(context.WithValue(r.Context(), ctxKeyRequestHost, host)) 71 | } 72 | 73 | func ErrAttr(err error) slog.Attr { 74 | return slog.Any("error", err) 75 | } 76 | 77 | func LogRequest(ctx context.Context, status int, msg string) { 78 | level := slog.LevelError 79 | if status < 400 { 80 | level = slog.LevelDebug 81 | } 82 | 83 | slog.LogAttrs(ctx, level, msg, slog.Int("status", status)) 84 | } 85 | -------------------------------------------------------------------------------- /internal/xlog/logger.go: -------------------------------------------------------------------------------- 1 | package xlog 2 | 3 | import ( 4 | "context" 5 | "log/slog" 6 | "os" 7 | "time" 8 | 9 | "github.com/jonashiltl/openchangelog/internal/config" 10 | ) 11 | 12 | func NewLogger(cfg config.Config) *slog.Logger { 13 | var sh slog.Handler 14 | 15 | if cfg.Log == nil { 16 | sh = slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{}) 17 | } else { 18 | switch cfg.Log.Style { 19 | case "json": 20 | sh = slog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{Level: cfg.Log.Level.ToSlog()}) 21 | default: 22 | sh = slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{Level: cfg.Log.Level.ToSlog()}) 23 | } 24 | } 25 | return slog.New(&myHandler{ 26 | Handler: sh, 27 | }) 28 | } 29 | 30 | type myHandler struct { 31 | slog.Handler 32 | } 33 | 34 | func (h *myHandler) Handle(ctx context.Context, r slog.Record) error { 35 | if rID, ok := ctx.Value(ctxKeyRequestID).(string); ok { 36 | r.AddAttrs(slog.String("request_id", rID)) 37 | } 38 | if wID, ok := ctx.Value(ctxKeyWorkspaceID).(string); ok { 39 | r.AddAttrs(slog.String("workspace_id", wID)) 40 | } 41 | if host, ok := ctx.Value(ctxKeyRequestHost).(string); ok { 42 | r.AddAttrs(slog.String("host", host)) 43 | } 44 | if rPath, ok := ctx.Value(ctxKeyRequestPath).(string); ok { 45 | r.AddAttrs(slog.String("path", rPath)) 46 | } 47 | if rMth, ok := ctx.Value(ctxKeyRequestMethod).(string); ok { 48 | r.AddAttrs(slog.String("method", rMth)) 49 | } 50 | if start, ok := ctx.Value(ctxKeyRequestStart).(time.Time); ok { 51 | r.AddAttrs(slog.Duration("duration", time.Since(start))) 52 | } 53 | return h.Handler.Handle(ctx, r) 54 | } 55 | 56 | func (h *myHandler) Enabled(ctx context.Context, level slog.Level) bool { 57 | return h.Handler.Enabled(ctx, level) 58 | } 59 | 60 | func (h *myHandler) WithAttrs(attrs []slog.Attr) slog.Handler { 61 | return &myHandler{Handler: h.Handler.WithAttrs(attrs)} 62 | } 63 | 64 | func (h *myHandler) WithGroup(name string) slog.Handler { 65 | return &myHandler{Handler: h.Handler.WithGroup(name)} 66 | } 67 | -------------------------------------------------------------------------------- /migrations/20240725163248_workspaces.sql: -------------------------------------------------------------------------------- 1 | -- +goose Up 2 | -- +goose StatementBegin 3 | CREATE TABLE IF NOT EXISTS workspaces ( 4 | id TEXT NOT NULL PRIMARY KEY, 5 | name TEXT NOT NULL 6 | ) STRICT; 7 | -- +goose StatementEnd 8 | 9 | -- +goose Down 10 | -- +goose StatementBegin 11 | DROP TABLE workspaces; 12 | -- +goose StatementEnd 13 | -------------------------------------------------------------------------------- /migrations/20240725163326_tokens.sql: -------------------------------------------------------------------------------- 1 | -- +goose Up 2 | -- +goose StatementBegin 3 | CREATE TABLE IF NOT EXISTS tokens ( 4 | key TEXT PRIMARY KEY, 5 | workspace_id TEXT NOT NULL REFERENCES workspaces(id) ON DELETE CASCADE 6 | ) STRICT; 7 | -- +goose StatementEnd 8 | 9 | -- +goose Down 10 | -- +goose StatementBegin 11 | DROP TABLE tokens; 12 | -- +goose StatementEnd 13 | -------------------------------------------------------------------------------- /migrations/20240725163619_changelog.sql: -------------------------------------------------------------------------------- 1 | -- +goose Up 2 | -- +goose StatementBegin 3 | CREATE TABLE IF NOT EXISTS changelogs ( 4 | id TEXT NOT NULL, 5 | workspace_id TEXT NOT NULL REFERENCES workspaces(id) ON DELETE CASCADE, 6 | subdomain TEXT NOT NULL, 7 | title TEXT, 8 | subtitle TEXT, 9 | source_id TEXT, 10 | logo_src TEXT, 11 | logo_link TEXT, 12 | logo_alt TEXT, 13 | logo_height TEXT, 14 | logo_width TEXT, 15 | created_at INTEGER NOT NULL DEFAULT (unixepoch('now')), 16 | PRIMARY KEY (workspace_id, id) 17 | ) STRICT; 18 | 19 | CREATE UNIQUE INDEX changelogs_subdomain ON changelogs(subdomain); 20 | -- +goose StatementEnd 21 | 22 | -- +goose Down 23 | -- +goose StatementBegin 24 | DROP INDEX changelogs_subdomain; 25 | DROP TABLE changelogs; 26 | -- +goose StatementEnd 27 | -------------------------------------------------------------------------------- /migrations/20240725163702_gh_sources.sql: -------------------------------------------------------------------------------- 1 | -- +goose Up 2 | -- +goose StatementBegin 3 | CREATE TABLE IF NOT EXISTS gh_sources ( 4 | id TEXT NOT NULL, 5 | workspace_id TEXT NOT NULL REFERENCES workspaces(id) ON DELETE CASCADE, 6 | owner TEXT NOT NULL, 7 | repo TEXT NOT NULL, 8 | path TEXT NOT NULL, 9 | installation_id INTEGER NOT NULL, 10 | PRIMARY KEY (workspace_id, id) 11 | ); 12 | -- +goose StatementEnd 13 | 14 | -- +goose Down 15 | -- +goose StatementBegin 16 | DROP TABLE gh_sources; 17 | -- +goose StatementEnd 18 | -------------------------------------------------------------------------------- /migrations/20240725163746_changelog_source.sql: -------------------------------------------------------------------------------- 1 | -- +goose Up 2 | -- +goose StatementBegin 3 | -- sqlc embed currently not workign with nullable embeds see this https://github.com/sqlc-dev/sqlc/issues/2997 4 | -- this view is used, because sqlc treats views as nullable 5 | CREATE VIEW changelog_source AS 6 | SELECT gh.* -- in future probably need to prefix this with gh_ 7 | FROM changelogs cl 8 | LEFT JOIN gh_sources gh 9 | ON cl.workspace_id = gh.workspace_id 10 | AND cl.source_id LIKE 'gh_%' 11 | AND cl.source_id = gh.id 12 | GROUP BY source_id, gh.workspace_id; 13 | -- +goose StatementEnd 14 | 15 | -- +goose Down 16 | -- +goose StatementBegin 17 | DROP VIEW changelog_source; 18 | -- +goose StatementEnd 19 | -------------------------------------------------------------------------------- /migrations/20240905083958_changelog_domain.sql: -------------------------------------------------------------------------------- 1 | -- +goose Up 2 | -- +goose StatementBegin 3 | ALTER TABLE changelogs ADD domain TEXT; 4 | CREATE UNIQUE INDEX changelogs_domain ON changelogs(domain); 5 | -- +goose StatementEnd 6 | 7 | -- +goose Down 8 | -- +goose StatementBegin 9 | DROP INDEX changelogs_domain; 10 | ALTER TABLE changelogs DROP domain; 11 | -- +goose StatementEnd 12 | -------------------------------------------------------------------------------- /migrations/20240911101434_changelog_color_scheme.sql: -------------------------------------------------------------------------------- 1 | -- +goose Up 2 | -- +goose StatementBegin 3 | ALTER TABLE changelogs ADD color_scheme INTEGER NOT NULL DEFAULT 1; 4 | -- +goose StatementEnd 5 | 6 | -- +goose Down 7 | -- +goose StatementBegin 8 | ALTER TABLE changelogs DROP color_scheme; 9 | -- +goose StatementEnd 10 | -------------------------------------------------------------------------------- /migrations/20240919193315_changelog_hide_powered_by.sql: -------------------------------------------------------------------------------- 1 | -- +goose Up 2 | -- +goose StatementBegin 3 | ALTER TABLE changelogs ADD hide_powered_by INTEGER NOT NULL DEFAULT 0 check (hide_powered_by in (0, 1)); 4 | -- +goose StatementEnd 5 | 6 | -- +goose Down 7 | -- +goose StatementBegin 8 | ALTER TABLE changelogs DROP hide_powered_by; 9 | -- +goose StatementEnd 10 | -------------------------------------------------------------------------------- /migrations/20241012104224_changelog_protected.sql: -------------------------------------------------------------------------------- 1 | -- +goose Up 2 | -- +goose StatementBegin 3 | ALTER TABLE changelogs ADD protected INTEGER NOT NULL DEFAULT 0 check (protected in (0, 1)); 4 | ALTER TABLE changelogs ADD password_hash TEXT; 5 | -- +goose StatementEnd 6 | 7 | -- +goose Down 8 | -- +goose StatementBegin 9 | ALTER TABLE changelogs DROP protected; 10 | ALTER TABLE changelogs DROP password_hash; 11 | -- +goose StatementEnd 12 | -------------------------------------------------------------------------------- /migrations/20241103174950_changelog_analytics.sql: -------------------------------------------------------------------------------- 1 | -- +goose Up 2 | -- +goose StatementBegin 3 | ALTER TABLE changelogs ADD analytics INTEGER NOT NULL DEFAULT 0 check (analytics in (0, 1)); 4 | -- +goose StatementEnd 5 | 6 | -- +goose Down 7 | -- +goose StatementBegin 8 | ALTER TABLE changelogs DROP analytics; 9 | -- +goose StatementEnd 10 | -------------------------------------------------------------------------------- /migrations/20241123104348_changelog_searchable.sql: -------------------------------------------------------------------------------- 1 | -- +goose Up 2 | -- +goose StatementBegin 3 | ALTER TABLE changelogs ADD searchable INTEGER NOT NULL DEFAULT 0 check (searchable in (0, 1)); 4 | -- +goose StatementEnd 5 | 6 | -- +goose Down 7 | -- +goose StatementBegin 8 | ALTER TABLE changelogs DROP searchable; 9 | -- +goose StatementEnd 10 | -------------------------------------------------------------------------------- /openchangelog.example.yml: -------------------------------------------------------------------------------- 1 | addr: 0.0.0.0:6001 2 | #log: 3 | #level: INFO (default), DEBUG, WARN, ERROR 4 | #style: text (default), json 5 | #github: 6 | # owner: 7 | # repo: 8 | # path: 9 | # auth: 10 | # accessToken: 11 | local: 12 | filesPath: /release-notes 13 | cache: 14 | type: disk 15 | disk: 16 | location: /data/cache/ 17 | #analytics: 18 | #provider: tinybird 19 | #tinybird: 20 | # accessToken: 21 | page: 22 | title: Changelog 23 | subtitle: The latest product updates from Openchangelog 24 | colorScheme: system 25 | hidePoweredBy: false 26 | logo: 27 | src: https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_92x30dp.png 28 | width: 70px 29 | height: 25px 30 | link: https://www.openchangelog.com 31 | auth: 32 | enabled: false 33 | # passwordHash: bcrypt encrypted hash of password 34 | search: 35 | type: disk 36 | disk: 37 | path: /data/search 38 | -------------------------------------------------------------------------------- /sqlc.yaml: -------------------------------------------------------------------------------- 1 | version: "2" 2 | sql: 3 | - engine: "sqlite" 4 | queries: 5 | - "internal/store/query.sql" 6 | schema: 7 | - "migrations/" 8 | gen: 9 | go: 10 | package: "store" 11 | out: "internal/store/" 12 | overrides: 13 | - db_type: "INTEGER" 14 | go_type: "int64" 15 | - db_type: "TEXT" 16 | nullable: true 17 | go_type: 18 | import: "github.com/jonashiltl/openchangelog/apitypes" 19 | type: "NullString" 20 | - column: "changelogs.color_scheme" 21 | go_type: 22 | type: "ColorScheme" 23 | 24 | rename: 25 | workspace: "workspace" 26 | token: "token" 27 | changelog: "changelog" 28 | gh_source: "ghSource" 29 | changelog_source: "changelogSource" 30 | -------------------------------------------------------------------------------- /widget/next/.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": [ 3 | "next/core-web-vitals", 4 | "next/typescript" 5 | ], 6 | "rules": { 7 | "@typescript-eslint/no-unused-vars": [ 8 | "error", 9 | { 10 | "args": "all", 11 | "argsIgnorePattern": "^_", 12 | "caughtErrors": "all", 13 | "caughtErrorsIgnorePattern": "^_", 14 | "destructuredArrayIgnorePattern": "^_", 15 | "varsIgnorePattern": "^_", 16 | "ignoreRestSiblings": true 17 | } 18 | ] 19 | } 20 | } -------------------------------------------------------------------------------- /widget/next/.gitignore: -------------------------------------------------------------------------------- 1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. 2 | 3 | # dependencies 4 | /node_modules 5 | /.pnp 6 | .pnp.js 7 | .yarn/install-state.gz 8 | 9 | # testing 10 | /coverage 11 | 12 | # next.js 13 | /.next/ 14 | /out/ 15 | 16 | # production 17 | /build 18 | /dist 19 | 20 | # misc 21 | .DS_Store 22 | *.pem 23 | 24 | # debug 25 | npm-debug.log* 26 | yarn-debug.log* 27 | yarn-error.log* 28 | 29 | # local env files 30 | .env*.local 31 | 32 | # vercel 33 | .vercel 34 | 35 | # typescript 36 | *.tsbuildinfo 37 | next-env.d.ts 38 | -------------------------------------------------------------------------------- /widget/next/.npmignore: -------------------------------------------------------------------------------- 1 | /node_modules 2 | /src 3 | /public 4 | 5 | .env 6 | 7 | tailwind.config.ts 8 | tsconfig.json 9 | tsup.config.ts -------------------------------------------------------------------------------- /widget/next/.npmrc: -------------------------------------------------------------------------------- 1 | registry=https://registry.npmjs.org/ 2 | always-auth=true -------------------------------------------------------------------------------- /widget/next/CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | All notable changes to this project will be documented in this file. 4 | 5 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), 6 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). 7 | 8 | ## [0.0.6] - 2024-10-27 9 | ### Fixed 10 | - Default *baseUrl* now points to the correct Openchangelog cloud url 11 | 12 | ## [0.0.5] - 2024-10-26 13 | 14 | ### Added 15 | - Support for Next.js 15 16 | - Support for React 19 -------------------------------------------------------------------------------- /widget/next/README.md: -------------------------------------------------------------------------------- 1 | # Openchangelog Next.js Widget 2 | 3 | A Next.js Server Component to embed your Openchangelog changelog into your Next.js app. 4 | For a summary of the most recent changes to the project, please see the [Changelog](https://next.openchangelog.com). 5 | 6 | ## Installation 7 | ``` 8 | npm i @openchangelog/next 9 | ``` 10 | 11 | ## Usage 12 | ```ts 13 | import { Changelog } from "@openchangelog/next" 14 | 15 | 16 | export default function ChangelogPage() { 17 | return ( 18 |