Skip to content

Commit

Permalink
Fix errors and bugs in internal usage (#2)
Browse files Browse the repository at this point in the history
* Fix wrong grammar in ReadMe

* Change the package of sisyphus protos

* Fix legacy component class name

* Default value for 'sisyphus.config' property

* Remove internal nexus dependency repository
  • Loading branch information
devkanro authored May 20, 2020
1 parent d7a19dc commit 8f8e57a
Show file tree
Hide file tree
Showing 9 changed files with 21 additions and 64 deletions.
5 changes: 0 additions & 5 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,5 @@ jobs:
with:
java-version: 1.11
- uses: ButterCam/prepare-sisyphus-build@bc33e0b
with:
dependency: nexus
nexus-url: ${{ secrets.NEXUS_PUBLIC_URL }}
nexus-username: ${{ secrets.NEXUS_USERNAME }}
nexus-password: ${{ secrets.NEXUS_PASSWORD }}
- name: Build with Gradle
run: gradle build
4 changes: 0 additions & 4 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,6 @@ jobs:
with:
snapshot: snapshot,mavenSnapshot
release: release,mavenRelease
dependency: nexus
nexus-url: ${{ secrets.NEXUS_PUBLIC_URL }}
nexus-username: ${{ secrets.NEXUS_USERNAME }}
nexus-password: ${{ secrets.NEXUS_PASSWORD }}
snapshot-url: ${{ secrets.NEXUS_SNAPSHOT_URL }}
snapshot-username: ${{ secrets.NEXUS_USERNAME }}
snapshot-password: ${{ secrets.NEXUS_PASSWORD }}
Expand Down
34 changes: 0 additions & 34 deletions .github/workflows/publishplugins.yml

This file was deleted.

28 changes: 14 additions & 14 deletions ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,41 +6,41 @@ Sisyphus is the way how we provide backend services. It integrates all tools and

## We are rolling a huge boulder

Due to we can analyze product documents completely, it is not particularly difficult to write an exquisite and easy-to-use API at the beginning for most APIs.
Due to analyzing product documents completely, it is not particularly difficult to write an exquisite and easy-to-use API at the beginning for most APIs.

However, many people will break the initial design of the API in the endless update of products.
However, many people will break the initial design of the API in the endless updates of products.

It's hard to create a strong and extensible API in the whole project lifetime, just like roll a huge boulder endlessly up a steep hill.
It's hard to create a strong and extensible API in the whole project lifetime, just like rolling a huge boulder endlessly up a steep hill.

So we need an all-encompassing guide book to guide us in creating, updating, and modifying APIs.

The [Google API Improvement Proposals](https://aip.bybutter.com) is the all-encompassing guide book. Google created it in their rich and extensive API design experience. Laid the foundation for possession for anyone to create an extensible API.
The [Google API Improvement Proposals](https://aip.bybutter.com) is the all-encompassing guide book. Google created it in their rich and extensive API design experience. It laid the foundation for anyone to create an extensible API.

## Good tools can help you

Choosing good tools can help you 'rolling a huge boulder' faster and easier. Sisyphus provides and integrates many tools in your 'boulder rolling' route.

[**Kotlin**](https://kotlinlang.org/) is our target language, the mature JVM community and concise grammar are the reasons.
[**Kotlin**](https://kotlinlang.org/) is our target language. The mature JVM community and concise grammar are the reasons.

[**Spring boot**](https://spring.io/projects/spring-boot) is our old friend to manage and organize our components.

[**gRPC**](https://grpc.io/) is our target API framework, and Sisyphus also provides the [HTTP and gRPC Transcoding](https://aip.bybutter.com/127) component for the environment which not compatible with gRPC.
[**gRPC**](https://grpc.io/) is our target API framework. Sisyphus also provides the [HTTP and gRPC Transcoding](https://aip.bybutter.com/127) component for the environment which isn't compatible with gRPC.

[**Sisyphus Protobuf**](/lib/sisyphus-protobuf) is our customized protobuf runtime, it designed for Kotlin.
[**Sisyphus Protobuf**](/lib/sisyphus-protobuf) is our customized protobuf runtime, which designed for Kotlin.

[**Sisyphus gRPC**](/lib/sisyphus-grpc) is our customized gRPC runtime, it designed for Kotlin coroutine.
[**Sisyphus gRPC**](/lib/sisyphus-grpc) is our customized gRPC runtime, which designed for Kotlin coroutine.

[**Sisyphus DTO**](/lib/sisyphus-dto) is our way to create struct without protobuf.
[**Sisyphus DTO**](/lib/sisyphus-dto) is the way how we create struct without protobuf.

[**Sisyphus Middleware**](/middleware) is our way to connect Sisyphus and other system.
[**Sisyphus Middleware**](/middleware) is the way how we connect Sisyphus and other systems.

[**Sisyphus Configuration Artifact**](/middleware/sisyphus-configuration-artifact) is our way to manage configurations and developing environment.
[**Sisyphus Configuration Artifact**](/middleware/sisyphus-configuration-artifact) is the way how we manage configurations and developing environment.

[**Sisyphus Protobuf Compiler**](/tools/sisyphus-protoc) is our way to generate Kotlin codes by `.proto` files.
[**Sisyphus Protobuf Compiler**](/tools/sisyphus-protoc) is the way how we generate Kotlin codes by `.proto` files.

[**Sisyphus Project Plugin**](/tools/sisyphus-project-gradle-plugin) is our way to manage project and configuring Gradle.
[**Sisyphus Project Plugin**](/tools/sisyphus-project-gradle-plugin) is the way how we manage project and configuring Gradle.

[**Sisyphus Protobuf Plugin**](/tools/sisyphus-protobuf-gradle-plugin) is our way to generate code by `.proto` files in Gradle.
[**Sisyphus Protobuf Plugin**](/tools/sisyphus-protobuf-gradle-plugin) is the way how we generate code by `.proto` files in Gradle.

**And More** tools like [CEL(Common Expression Language)](https://github.com/google/cel-spec), [Filtering](https://aip.bybutter.com/160) and [Ordering](https://aip.bybutter.com/132#ordering) Script will help you to design APIs follow Google AIP.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
com.bybutter.dto.jackson.DtoModule
com.bybutter.sisyphus.dto.jackson.DtoModule
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
syntax = "proto3";

package bybutter.api.paging;
package sisyphus.api.paging;

option java_package = "com.bybutter.sisyphus.api.paging";
option objc_class_prefix = "SIS";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
syntax = "proto3";

package bybutter.api;
package sisyphus.api;

import "google/protobuf/descriptor.proto";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ import org.springframework.boot.context.properties.NestedConfigurationProperty

data class SisyphusProperty(
@NestedConfigurationProperty
val repositories: Map<String, Repository> = mapOf(),
val repositories: Map<String, Repository> = mapOf(),
@NestedConfigurationProperty
val dependency: TargetRepositorySetting = TargetRepositorySetting(),
val dependency: TargetRepositorySetting = TargetRepositorySetting(),
@NestedConfigurationProperty
val config: SisyphusConfigArtifacts
val config: SisyphusConfigArtifacts = SisyphusConfigArtifacts()
)

data class TargetRepositorySetting(val repositories: List<String> = listOf("local", "central", "jcenter", "portal"))
Expand Down
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.bybutter.starter.grpc.AutoConfig
com.bybutter.sisyphus.starter.grpc.SisyphusGrpcServerAutoConfiguration

0 comments on commit 8f8e57a

Please sign in to comment.