This repository has been archived by the owner on Apr 3, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 75
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
115 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
name: Bug report | ||
about: Report a bug or unexpected behavior with Temporalite | ||
title: '' | ||
labels: potential-bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Expected Behavior | ||
|
||
|
||
## Actual Behavior | ||
|
||
|
||
## Steps to Reproduce the Problem | ||
|
||
1. | ||
1. | ||
1. | ||
|
||
## Specifications | ||
|
||
- Version: | ||
- Platform: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea or enhancement for Temporalite | ||
title: '' | ||
labels: enhancement | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
<!-- Describe what has changed in this PR --> | ||
**What changed?** | ||
|
||
|
||
<!-- Tell your future self why have you made these changes --> | ||
**Why?** | ||
|
||
|
||
<!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> | ||
**How did you test it?** | ||
|
||
|
||
<!-- Assuming the worst case, what can be broken when deploying this change to production? --> | ||
**Potential risks** | ||
|
||
|
||
<!-- Is this PR a hotfix candidate or require that a notification be sent to the broader community? (Yes/No) --> | ||
**Is hotfix candidate?** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# Develop Temporalite | ||
This doc is for contributors to Temporalite (hopefully that's you!) | ||
|
||
[comment]: <> (TODO: CLA?) | ||
|
||
[comment]: <> (**Note:** All contributors also need to fill out the [Temporal Contributor License Agreement](https://gist.github.com/samarabbas/7dcd41eb1d847e12263cc961ccfdb197) before we can merge in any of your changes.) | ||
|
||
## Prerequisites | ||
|
||
### Build prerequisites | ||
* [Go Lang](https://golang.org/) (minimum version required is 1.17): | ||
- Install on macOS with `brew install go`. | ||
- Install on Ubuntu with `sudo apt install golang`. | ||
|
||
## Check out the code | ||
Temporalite uses go modules, there is no dependency on `$GOPATH` variable. Clone the repo into the preferred location: | ||
```bash | ||
git clone https://github.com/DataDog/temporalite.git | ||
``` | ||
|
||
## Build | ||
Build the `temporalite` binary: | ||
```bash | ||
go build ./cmd/temporalite | ||
``` | ||
|
||
## Run tests | ||
Run all tests: | ||
```bash | ||
go test -race ./... | ||
``` | ||
|
||
## Run Temporal Server locally | ||
Run the server in ephemeral mode: | ||
```bash | ||
go run ./cmd/temporalite start --ephemeral | ||
``` | ||
|
||
Now you can create default namespace with `tctl`: | ||
```bash | ||
tctl --ns default namespace register | ||
``` | ||
and run samples from [Go](https://github.com/temporalio/samples-go) and [Java](https://github.com/temporalio/samples-java) samples repos. | ||
|
||
When you are done, press `Ctrl+C` to stop the server. | ||
|
||
## License headers | ||
This project is Open Source Software, and requires a header at the beginning of | ||
all source files. To verify that all files contain the header execute: | ||
```bash | ||
go run ./internal/copyright | ||
``` |