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.

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

refactor: refactor the analysis API. #232

Merged
merged 2 commits into from
Oct 22, 2024

Conversation

peterhuene
Copy link
Collaborator

@peterhuene peterhuene commented Oct 21, 2024

This PR refactors the analysis API to assist in future engine work.

Primarily it exposes Task and Workflow from analyzed documents so that a task or workflow's inputs and outputs can be easily determined.

Additionally, this renames DocumentScope to simply Document to represent an analyzed document.

Scopes are now kept internally to a Task or Workflow, which allows for a scope method directly on those types.

As a result of the rename, scope.rs has been renamed to document.rs.

Before submitting this PR, please make sure:

  • You have added a few sentences describing the PR here.
  • You have added yourself or the appropriate individual as the assignee.
  • You have added at least one relevant code reviewer to the PR.
  • Your code builds clean without any errors or warnings.
  • You have added tests (when appropriate).
  • You have updated the README or other documentation to account for these
    changes (when appropriate).
  • You have added an entry to the relevant CHANGELOG.md (see
    "keep a changelog" for more information).
  • Your commit messages follow the conventional commit style.

This commit refactors the analysis API to assist in future engine work.

Primarily it exposes `Task` and `Workflow` from analyzed documents so that a
task or workflow's inputs and outputs can be easily determined.

Additionally, this renames `DocumentScope` to simply `Document` to represent an
analyzed document.

Scopes are now kept internally to a `Task` or `Workflow`, which allows for a
`scope` method directly on those types.

As a result of the rename, `scope.rs` has been renamed to `document.rs`.
@peterhuene peterhuene merged commit 54bbd99 into stjude-rust-labs:main Oct 22, 2024
12 checks passed
@peterhuene peterhuene deleted the engine branch October 22, 2024 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants