Skip to content

Commit 35f3b79

Browse files
authored
Merge pull request #4 from Singularity-ng/copilot/rename-quantum-flow
BREAKING: Rename QuantumFlow to Singularity.Workflow throughout codebase
2 parents 8924abe + 07cda54 commit 35f3b79

89 files changed

Lines changed: 1110 additions & 414 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ What actually happens?
2929
- Elixir version: (run `elixir --version`)
3030
- Erlang/OTP version: (run `erl -eval 'erlang:halt(0).'`)
3131
- PostgreSQL version: (run `psql --version`)
32-
- QuantumFlow version: 0.1.0
32+
- Singularity.Workflow version: 1.0.x
3333
- OS: (e.g., macOS, Ubuntu, etc.)
3434

3535
## Minimal Code Example

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Feature Request
3-
about: Suggest an idea for improving QuantumFlow
3+
about: Suggest an idea for improving Singularity.Workflow
44
title: "[FEATURE] "
55
labels: enhancement
66
---

.github/ISSUE_TEMPLATE/question.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
name: Question
3-
about: Ask a question about QuantumFlow
3+
about: Ask a question about Singularity.Workflow
44
title: "[QUESTION] "
55
labels: question
66
---
77

88
## Question
99

10-
What would you like to know about QuantumFlow?
10+
What would you like to know about Singularity.Workflow?
1111

1212
## Context
1313

@@ -18,10 +18,10 @@ Provide any relevant context about your question:
1818

1919
## Documentation Checked
2020

21-
- [ ] [GETTING_STARTED.md](https://github.com/mikkihugo/quantum_flow/blob/main/GETTING_STARTED.md)
22-
- [ ] [ARCHITECTURE.md](https://github.com/mikkihugo/quantum_flow/blob/main/ARCHITECTURE.md)
23-
- [ ] Generated API docs (https://hexdocs.pm/quantum_flow)
24-
- [ ] [docs/ reference materials](https://github.com/mikkihugo/quantum_flow/tree/main/docs)
21+
- [ ] [GETTING_STARTED.md](https://github.com/Singularity-ng/singularity-workflows/blob/main/GETTING_STARTED.md)
22+
- [ ] [ARCHITECTURE.md](https://github.com/Singularity-ng/singularity-workflows/blob/main/ARCHITECTURE.md)
23+
- [ ] Generated API docs (https://hexdocs.pm/singularity_workflow)
24+
- [ ] [docs/ reference materials](https://github.com/Singularity-ng/singularity-workflows/tree/main/docs)
2525

2626
## Code Example (if applicable)
2727

.github/workflows/docker-build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ on:
1010

1111
env:
1212
REGISTRY: ghcr.io
13-
IMAGE_NAME: mikkihugo/quantum_flow-postgres
13+
IMAGE_NAME: singularity-ng/singularity_workflow-postgres
1414

1515
jobs:
1616
build-postgres:

.github/workflows/publish.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
env:
1919
POSTGRES_USER: postgres
2020
POSTGRES_PASSWORD: postgres
21-
POSTGRES_DB: quantum_flow_test
21+
POSTGRES_DB: singularity_workflow_test
2222
options: >-
2323
--health-cmd pg_isready
2424
--health-interval 10s
@@ -41,9 +41,9 @@ jobs:
4141
# Wait for PostgreSQL to be ready
4242
until pg_isready -h localhost -U postgres; do sleep 1; done
4343
# Create the database if it doesn't exist
44-
PGPASSWORD=postgres psql -h localhost -U postgres -c "CREATE DATABASE IF NOT EXISTS quantum_flow_test;"
44+
PGPASSWORD=postgres psql -h localhost -U postgres -c "CREATE DATABASE IF NOT EXISTS singularity_workflow_test;"
4545
# pgmq extension is pre-installed in tembo/pgmq image
46-
PGPASSWORD=postgres psql -h localhost -U postgres -d quantum_flow_test -c "CREATE EXTENSION IF NOT EXISTS pgmq;"
46+
PGPASSWORD=postgres psql -h localhost -U postgres -d singularity_workflow_test -c "CREATE EXTENSION IF NOT EXISTS pgmq;"
4747
4848
- name: Restore dependencies cache
4949
uses: actions/cache@v4
@@ -61,7 +61,7 @@ jobs:
6161
MIX_ENV: test
6262
POSTGRES_USER: postgres
6363
POSTGRES_PASSWORD: postgres
64-
POSTGRES_DB: quantum_flow_test
64+
POSTGRES_DB: singularity_workflow_test
6565
POSTGRES_HOST: localhost
6666

6767
- name: Check formatting

CHANGELOG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2525

2626
### Added
2727

28-
- Initial release of QuantumFlow - Elixir implementation of QuantumFlow's database-driven DAG execution
29-
- Complete feature parity with QuantumFlow including:
28+
- Initial release of Singularity.Workflow - Elixir implementation of database-driven DAG execution
29+
- Complete feature parity including:
3030
- **DAG Workflow Support**: Define workflows with explicit dependencies between steps
3131
- **Parallel Execution**: Automatically execute independent steps in parallel
3232
- **Map Steps**: Execute the same step across multiple items (map/reduce pattern)
3333
- **Dependency Merging**: Steps can depend on multiple other steps
3434
- **Database-First Coordination**: PostgreSQL + pgmq for reliable task coordination
35-
- **Multi-Instance Scaling**: Multiple QuantumFlow instances can safely execute the same workflows
35+
- **Multi-Instance Scaling**: Multiple Singularity.Workflow instances can safely execute the same workflows
3636
- **Visibility Timeout Pattern**: Automatic retry if task executor crashes
3737
- **Comprehensive Testing**: 160+ tests covering all execution paths
3838

@@ -87,7 +87,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
8787

8888
### Known Limitations (v0.1.0)
8989

90-
- Step definitions use legacy Elixir module functions (not JSON-based like QuantumFlow)
90+
- Step definitions use Elixir module functions
9191
- Plan to support JSON workflow definitions in v0.2.0
9292
- Conditional step execution not yet supported
9393
- Plan for v0.2.0

CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to QuantumFlow
1+
# Contributing to Singularity.Workflow
22

3-
Thank you for your interest in QuantumFlow! This document provides guidelines for contributing to the project.
3+
Thank you for your interest in Singularity.Workflow! This document provides guidelines for contributing to the project.
44

55
## Getting Started
66

@@ -48,7 +48,7 @@ mix test
4848
mix test
4949

5050
# Run specific test file
51-
mix test test/QuantumFlow/executor_test.exs
51+
mix test test/singularity_workflow/executor_test.exs
5252

5353
# Run tests with coverage report
5454
mix test.coverage
@@ -59,7 +59,7 @@ mix test.watch
5959

6060
### Code Quality
6161

62-
QuantumFlow enforces high code quality standards:
62+
Singularity.Workflow enforces high code quality standards:
6363

6464
```bash
6565
# Run all quality checks (recommended before committing)
@@ -75,7 +75,7 @@ mix deps.audit # Check dependencies for vulnerabilities
7575

7676
### Code Style
7777

78-
QuantumFlow follows standard Elixir conventions:
78+
Singularity.Workflow follows standard Elixir conventions:
7979

8080
1. **Formatting**: Run `mix format` before committing
8181
2. **Line Length**: Maximum 100 characters (enforced in .formatter.exs)
@@ -138,7 +138,7 @@ All code contributions must include:
138138

139139
### Database-First Design
140140

141-
QuantumFlow uses PostgreSQL as the source of truth. When adding features:
141+
Singularity.Workflow uses PostgreSQL as the source of truth. When adding features:
142142

143143
1. **Schema Changes**: Create migrations for all schema additions
144144
2. **SQL Functions**: Complex logic lives in PostgreSQL functions (for atomicity)
@@ -186,7 +186,7 @@ When working with workflows:
186186

187187
```
188188
singularity_workflow/
189-
├── lib/QuantumFlow/
189+
├── lib/singularity_workflow/
190190
│ ├── executor.ex # Main entry point
191191
│ ├── flow_builder.ex # Dynamic workflow API
192192
│ ├── repo.ex # Ecto repository
@@ -200,7 +200,7 @@ singularity_workflow/
200200
├── priv/repo/
201201
│ └── migrations/ # Database migrations
202202
├── test/
203-
│ ├── QuantumFlow/
203+
│ ├── singularity_workflow/
204204
│ │ └── *_test.exs # Unit/integration tests
205205
│ └── support/
206206
│ └── sql_case.ex # Test helpers
@@ -324,7 +324,7 @@ Reviewers may request changes. Please:
324324

325325
## Release Process
326326

327-
QuantumFlow follows [Semantic Versioning](https://semver.org/):
327+
Singularity.Workflow follows [Semantic Versioning](https://semver.org/):
328328

329329
- **0.1.0** (current): Initial release, API may change
330330
- **0.x.0**: Minor versions (new features, API additions)
@@ -348,4 +348,4 @@ Only maintainers can publish releases:
348348
- **Architecture questions**: See [ARCHITECTURE.md](docs/ARCHITECTURE.md)
349349
- **Issue or PR**: Open a GitHub issue
350350

351-
Thank you for contributing to QuantumFlow!
351+
Thank you for contributing to Singularity.Workflow!

GETTING_STARTED.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Getting Started with QuantumFlow
1+
# Getting Started with Singularity.Workflow
22

3-
QuantumFlow is an Elixir implementation of [QuantumFlow](https://github.com/singularity_workflow-dev/QuantumFlow), a database-driven DAG execution engine. This guide walks you through installation, basic setup, and running your first workflow.
3+
Singularity.Workflow is an Elixir implementation of [Singularity.Workflow](https://github.com/singularity_workflow-dev/Singularity.Workflow), a database-driven DAG execution engine. This guide walks you through installation, basic setup, and running your first workflow.
44

55
## Installation
66

@@ -22,15 +22,15 @@ mix deps.get
2222

2323
## Database Setup
2424

25-
QuantumFlow requires PostgreSQL 14+ with the `pgmq` extension:
25+
Singularity.Workflow requires PostgreSQL 14+ with the `pgmq` extension:
2626

2727
### 1. Create a PostgreSQL Database
2828

2929
```bash
3030
createdb my_app
3131
```
3232

33-
### 2. Add QuantumFlow Repository
33+
### 2. Add Singularity.Workflow Repository
3434

3535
Configure Ecto in your app to include the Singularity.Workflow.Repo:
3636

@@ -57,7 +57,7 @@ psql my_app -c "CREATE EXTENSION IF NOT EXISTS pgmq"
5757
### 4. Run Migrations
5858

5959
```bash
60-
# Generate migrations for QuantumFlow tables
60+
# Generate migrations for Singularity.Workflow tables
6161
mix ecto.gen.migration init_singularity_workflow
6262

6363
# Run all migrations
@@ -155,7 +155,7 @@ IO.inspect(run.status) # => "completed"
155155

156156
## DAG Workflows with Dependencies
157157

158-
QuantumFlow supports complex DAG workflows with parallel execution and dependency management:
158+
Singularity.Workflow supports complex DAG workflows with parallel execution and dependency management:
159159

160160
```elixir
161161
defmodule MyApp.Workflows.DataPipeline do
@@ -394,7 +394,7 @@ For the complete guide, see [HTDAG_ORCHESTRATOR_GUIDE.md](docs/HTDAG_ORCHESTRATO
394394

395395
## Configuration
396396

397-
QuantumFlow respects these environment variables:
397+
Singularity.Workflow respects these environment variables:
398398

399399
```bash
400400
# PostgreSQL connection
@@ -448,7 +448,7 @@ Executor.execute_pending_tasks()
448448

449449
### Type errors in custom workflows
450450

451-
QuantumFlow uses Dialyzer for type checking. Run:
451+
Singularity.Workflow uses Dialyzer for type checking. Run:
452452

453453
```bash
454454
mix dialyzer

SECURITY.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Include in your report:
2222

2323
## Security Considerations
2424

25-
QuantumFlow is designed for workflow orchestration in trusted environments. Here are important security practices:
25+
Singularity.Workflow is designed for workflow orchestration in trusted environments. Here are important security practices:
2626

2727
### Database Security
2828

@@ -107,11 +107,11 @@ QuantumFlow is designed for workflow orchestration in trusted environments. Here
107107

108108
## Security Audit
109109

110-
QuantumFlow has been reviewed for common vulnerabilities. See [SECURITY_AUDIT.md](docs/SECURITY_AUDIT.md) for detailed findings.
110+
Singularity.Workflow has been reviewed for common vulnerabilities. See [SECURITY_AUDIT.md](docs/SECURITY_AUDIT.md) for detailed findings.
111111

112112
## Dependencies
113113

114-
QuantumFlow uses well-maintained Elixir packages. Dependency security is monitored with:
114+
Singularity.Workflow uses well-maintained Elixir packages. Dependency security is monitored with:
115115
- `mix deps.audit` - Check for known vulnerabilities
116116
- Regular dependency updates
117117
- GitHub Dependabot alerts
@@ -150,4 +150,4 @@ For security-related questions that aren't vulnerabilities, open an issue with t
150150
---
151151

152152
Last Updated: 2025-01-10
153-
QuantumFlow Version: 0.1.0
153+
Singularity.Workflow Version: 1.0.x

0 commit comments

Comments
 (0)