Skip to content

Commit

Permalink
Refactoring - docs, tests and examples (#143)
Browse files Browse the repository at this point in the history
1. Restructure project directories. 
  -- Moved `internal/testdata` to `test/testdata`. 
  -- Moved `test/common/common.go` to `testdata/util.go` (to avoid exposing that `common` package)
2. Added executable **hello world!** example under `examples` module.
3. Api Docs - added a `\n` between License and package declaration to prevent License from being parsed as part of the package documentation.
4. Removed outdated API reference under `docs`. https://pkg.go.dev/github.com/conductor-sdk/conductor-go will be the source of truth.
5. Changes in `README.md` 
 -- Removed running conductor section. 
 -- Use updated hello world example (More to come).
6. Fix License.
  • Loading branch information
jmigueprieto authored Jul 9, 2024
1 parent cd3b9a2 commit a535932
Show file tree
Hide file tree
Showing 82 changed files with 609 additions and 4,167 deletions.
1 change: 0 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
FROM golang:1.17 as build
RUN mkdir /package
COPY /internal /package/internal
COPY /sdk /package/sdk
COPY /go.mod /package/go.mod
COPY /go.sum /package/go.sum
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]
Copyright 2024 Orkes, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
Loading

0 comments on commit a535932

Please sign in to comment.