Skip to content

Commit

Permalink
Publish with source code and java doc (#63)
Browse files Browse the repository at this point in the history
  • Loading branch information
longquanzheng authored Nov 9, 2022
1 parent fd4045a commit 807f71f
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 16 deletions.
9 changes: 8 additions & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ jar {
enabled = true
}

java {
sourceCompatibility = JavaVersion.VERSION_1_8
targetCompatibility = JavaVersion.VERSION_1_8
withJavadocJar()
withSourcesJar()
}

repositories {
// Use Maven Central for resolving dependencies.
mavenCentral()
Expand Down Expand Up @@ -141,7 +148,7 @@ signing {
}

group = "io.github.cadence-oss"
version = "1.0.1-rc1"
version = "1.0.0-rc3"

nexusPublishing {
repositories {
Expand Down
15 changes: 7 additions & 8 deletions src/main/java/io/github/cadenceoss/iwf/core/Client.java
Original file line number Diff line number Diff line change
Expand Up @@ -116,14 +116,14 @@ public void SignalWorkflow(
}

/**
* @param workflowId required
* @param workflowRunId optional, default to current runId
* @param resetType rquired
* @param historyEventId required for resetType of HISTORY_EVENT_ID. The eventID of any event after DecisionTaskStarted you want to reset to (this event is exclusive in a new run. The new run history will fork and continue from the previous eventID of this). It can be DecisionTaskCompleted, DecisionTaskFailed or others
* @param reason reason to do the reset for tracking purpose
* @param workflowId required
* @param workflowRunId optional, default to current runId
* @param resetType required
* @param historyEventId required for resetType of HISTORY_EVENT_ID. The eventID of any event after DecisionTaskStarted you want to reset to (this event is exclusive in a new run. The new run history will fork and continue from the previous eventID of this). It can be DecisionTaskCompleted, DecisionTaskFailed or others
* @param reason reason to do the reset for tracking purpose
* @param resetBadBinaryChecksum required for resetType of BAD_BINARY. Binary checksum for resetType of BadBinary
* @param decisionOffset based on the reset point calculated by resetType, this offset will move/offset the point by decision. Currently only negative number is supported, and only works with LastDecisionCompleted
* @param earliestTime required for resetType of DECISION_COMPLETED_TIME. EarliestTime of decision start time, required for resetType of DecisionCompletedTime.Supported formats are '2006-01-02T15:04:05+07:00', raw UnixNano and time range (N<duration>), where 0 < N < 1000000 and duration (full-notation/short-notation) can be second/s, minute/m, hour/h, day/d, week/w, month/M or year/y. For example, '15minute' or '15m' implies last 15 minutes, meaning that workflow will be reset to the first decision that completed in last 15 minutes
* @param decisionOffset based on the reset point calculated by resetType, this offset will move/offset the point by decision. Currently only negative number is supported, and only works with LastDecisionCompleted
* @param earliestTime required for resetType of DECISION_COMPLETED_TIME. EarliestTime of decision start time, required for resetType of DecisionCompletedTime.Supported formats are '2006-01-02T15:04:05+07:00', raw UnixNano and time range
* @param skipSignalReapply
* @return
*/
Expand All @@ -147,7 +147,6 @@ public String ResetWorkflow(
*
* @param workflowId required
* @param workflowRunId optional, can be empty
* @return
*/
public void CancelWorkflow(
final String workflowId,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
package io.github.cadenceoss.iwf.core;

import io.github.cadenceoss.iwf.core.attributes.AttributeLoadingPolicy;
import io.github.cadenceoss.iwf.core.command.BaseCommand;
import io.github.cadenceoss.iwf.core.command.CommandCarryOverPolicy;
import io.github.cadenceoss.iwf.core.command.CommandCarryOverType;
import io.github.cadenceoss.iwf.core.command.CommandRequest;
import org.immutables.value.Value;

@Value.Immutable
public abstract class StateOptions {

/**
* when using {@link CommandRequest#forAnyCommandClosed or {@link CommandRequest#forAnyCommandsCompleted(BaseCommand...)}
* when using forAnyCommandClosed or forAnyCommandsCompleted
* there could be some unfinished commands left to this state. This policy decided whether and how to carry over those unfinished command to
* future states. Default to {@link CommandCarryOverType#NONE} which means no carry over.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ public void SignalWorkflow(
* @param reason reason to do the reset for tracking purpose
* @param resetBadBinaryChecksum required for resetType of BAD_BINARY. Binary checksum for resetType of BadBinary
* @param decisionOffset based on the reset point calculated by resetType, this offset will move/offset the point by decision. Currently only negative number is supported, and only works with LastDecisionCompleted
* @param earliestTime required for resetType of DECISION_COMPLETED_TIME. EarliestTime of decision start time, required for resetType of DecisionCompletedTime.Supported formats are '2006-01-02T15:04:05+07:00', raw UnixNano and time range (N<duration>), where 0 < N < 1000000 and duration (full-notation/short-notation) can be second/s, minute/m, hour/h, day/d, week/w, month/M or year/y. For example, '15minute' or '15m' implies last 15 minutes, meaning that workflow will be reset to the first decision that completed in last 15 minutes
* @param earliestTime required for resetType of DECISION_COMPLETED_TIME. EarliestTime of decision start time, required for resetType of DecisionCompletedTime
* @param skipSignalReapply
* @return
*/
Expand Down Expand Up @@ -168,7 +168,6 @@ public String ResetWorkflow(
*
* @param workflowId required
* @param workflowRunId optional
* @return
*/
public void CancelWorkflow(
final String workflowId,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ public interface StateLocal {
/**
* set a local attribute. The scope of the attribute is only within the execution of this state.
* Usually it's for passing from State Start API to State Decide API
* User code must make sure using the same type for both get & set
* User code must make sure using the same type for both get and set
*
* @param key
* @param value
Expand All @@ -13,7 +13,7 @@ public interface StateLocal {

/**
* Retrieve a local state attribute
* User code must make sure using the same type for both get & set
* User code must make sure using the same type for both get and set
*
* @param key
* @param type
Expand Down

0 comments on commit 807f71f

Please sign in to comment.