Skip to content

Commit

Permalink
internal: Rename master branch to main (#3116)
Browse files Browse the repository at this point in the history
  • Loading branch information
xerial authored Aug 7, 2023
1 parent 40fe39d commit a7f5638
Show file tree
Hide file tree
Showing 26 changed files with 62 additions and 104 deletions.
8 changes: 4 additions & 4 deletions .github/workflows/codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@ on:
- '**.scala'
- '**.java'
- '**.sbt'
- '**/codecov.yml'
- '**/codecov.yml'
- '.scalafmt.conf'
- 'project/build.properties'
- 'project/build.properties'
push:
branches:
- master
- main
paths:
- '**.scala'
- '**.java'
- '**.sbt'
- '**/codecov.yml'
- '.scalafmt.conf'
- 'project/build.properties'
- 'project/build.properties'

jobs:
coverage:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Doc
on:
push:
branches:
- master
- main
paths:
- 'docs/**'
- 'website/**'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/package-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: CI Packaging
on:
push:
branches:
- master
- main
paths:
- '**.scala'
- '**.java'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/sbt-integration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ on:
- 'project/build.properties'
push:
branches:
- master
- main
paths:
- '**.scala'
- '**.java'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/snapshot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Snapshot Release
on:
push:
branches:
- master
- main
paths:
- '**.scala'
- '**.java'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ on:
- 'project/build.properties'
push:
branches:
- master
- main
paths:
- '**.scala'
- '**.java'
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
[![Gitter Chat][gitter-badge]][gitter-link] [![CI Status][gha-badge]][gha-link] [![codecov](https://codecov.io/gh/wvlet/airframe/branch/master/graph/badge.svg)](https://codecov.io/gh/wvlet/airframe) [![scala-index][sindex-badge]][sindex-link] [![maven central][central-badge]][central-link] [![Scala.js](https://www.scala-js.org/assets/badges/scalajs-1.0.0.svg)](https://www.scala-js.org)
[![Gitter Chat][gitter-badge]][gitter-link] [![CI Status][gha-badge]][gha-link] [![codecov](https://codecov.io/gh/wvlet/airframe/branch/main/graph/badge.svg)](https://codecov.io/gh/wvlet/airframe) [![scala-index][sindex-badge]][sindex-link] [![maven central][central-badge]][central-link] [![Scala.js](https://www.scala-js.org/assets/badges/scalajs-1.0.0.svg)](https://www.scala-js.org)

[circleci-badge]: https://circleci.com/gh/wvlet/airframe.svg?style=svg
[circleci-link]: https://circleci.com/gh/wvlet/airframe
[gha-badge]: https://github.com/wvlet/airframe/workflows/CI/badge.svg
[gha-link]: https://github.com/wvlet/airframe/actions?workflow=CI
[gitter-badge]: https://badges.gitter.im/Join%20Chat.svg
[gitter-link]: https://gitter.im/wvlet/airframe?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
[coverall-badge]: https://coveralls.io/repos/github/wvlet/airframe/badge.svg?branch=master
[coverall-link]: https://coveralls.io/github/wvlet/airframe?branch=master
[coverall-badge]: https://coveralls.io/repos/github/wvlet/airframe/badge.svg?branch=main
[coverall-link]: https://coveralls.io/github/wvlet/airframe?branch=main
[sindex-badge]: https://index.scala-lang.org/wvlet/airframe/airframe/latest.svg?color=orange
[sindex-link]: https://index.scala-lang.org/wvlet/airframe
[central-badge]: https://img.shields.io/maven-central/v/org.wvlet.airframe/airframe_2.12.svg?label=maven%20central
[central-link]: https://search.maven.org/search?q=g:%22org.wvlet.airframe%22%20AND%20a:%22airframe_2.12%22


<p><img src="https://github.com/wvlet/airframe/raw/master/logos/airframe-badge-light.png" alt="logo" width="300px"></p>
<p><img src="https://github.com/wvlet/airframe/raw/main/logos/airframe-badge-light.png" alt="logo" width="300px"></p>

Airframe https://wvlet.org/airframe is a collection of [lightweight building blocks](https://wvlet.org/airframe/docs/) for Scala.

Expand All @@ -30,10 +30,10 @@ Airframe https://wvlet.org/airframe is a collection of [lightweight building blo
- [AirSpec: A Functional Testing Library](https://wvlet.org/airframe/docs/airspec.html)

- [Airframe RPC: A Framework for Using Scala Both for Frontend and Backend Programming](https://wvlet.org/airframe/docs/airframe-rpc.html)
<p><img src="https://github.com/wvlet/airframe/raw/master/website/static/img/airframe-rpc/rpc-overview.png" alt="rpc" width="800px"></p>
<p><img src="https://github.com/wvlet/airframe/raw/main/website/static/img/airframe-rpc/rpc-overview.png" alt="rpc" width="800px"></p>

- [Airframe Modules](https://wvlet.org/airframe/docs/index.html)
<p><img src="https://github.com/wvlet/airframe/raw/master/logos/airframe-overview.png" alt="logo" width="800px"></p>
<p><img src="https://github.com/wvlet/airframe/raw/main/logos/airframe-overview.png" alt="logo" width="800px"></p>


## For Developers
Expand All @@ -59,12 +59,12 @@ Here is the list of milestones for Dotty support: [#1077](https://github.com/wvl

### Releasing

For every PR, [release-drafter](https://github.com/release-drafter/release-drafter) will automatically label PRs using the rules defined in [.github/release-drafter.yml](https://github.com/wvlet/airframe/blob/master/.github/release-drafter.yml).
For every PR, [release-drafter](https://github.com/release-drafter/release-drafter) will automatically label PRs using the rules defined in [.github/release-drafter.yml](https://github.com/wvlet/airframe/blob/main/.github/release-drafter.yml).

To publish a new version, first, create a new release tag as follows:

```sh
$ git switch master
$ git switch main
$ git pull
$ ruby ./scripts/release.rb
```
Expand All @@ -80,4 +80,4 @@ When changing some interfaces, binary compatibility should be checked so as not

## LICENSE

[Apache v2](https://github.com/wvlet/airframe/blob/master/LICENSE)
[Apache v2](https://github.com/wvlet/airframe/blob/main/LICENSE)
8 changes: 4 additions & 4 deletions airframe-log/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ libraryDependencies += "org.wvlet.airframe" %%% "airframe-log" % "(version)"
- Scala 2.12, 2.13, Scala.js support

## Resources
- GitHub: [airframe-log](https://github.com/wvlet/airframe/tree/master/airframe-log)
- GitHub: [airframe-log](https://github.com/wvlet/airframe/tree/main/airframe-log)
- Blog post: [Airframe Log: A Modern Logging Library for Scala](https://medium.com/@taroleo/airframe-log-a-modern-logging-library-for-scala-56fbc2f950bc)


Expand Down Expand Up @@ -123,7 +123,7 @@ call `Logger.scheduleLogLevelScan` before running test cases. This is useful for

To scan log level properties periodically with [ScalaTest](http://www.scalatest.org/), define the base trait as follows:

**[Spec.scala](https://github.com/wvlet/log/blob/master/src/test/scala/wvlet/log/Spec.scala)**
**[Spec.scala](https://github.com/wvlet/airframe/blob/airframe-log/main/src/test/scala/wvlet/log/Spec.scala)**
```scala
import org.scalatest.{BeforeAndAfter, BeforeAndAfterAll, WordSpec, _}
import wvlet.log.LogFormatter.SourceCodeLogFormatter
Expand Down Expand Up @@ -161,7 +161,7 @@ You can show the source code location where the log message is generated:
```scala
import wvlet.log._

object MyApp with LogSupport {
object MyApp extends LogSupport {
Logger.setDefaultFormatter(LogFormatter.SourceCodeLogFormatter)
info("log with source code")
}
Expand Down Expand Up @@ -194,7 +194,7 @@ object CustomLogFormatter extends LogFormatter {

Logger.setDefaultFormatter(CustomLogFormatter)
```
See also the examples in [LogFormat.scala](https://github.com/wvlet/airframe/blob/master/airframe-log/shared/src/main/scala/wvlet/log/LogFormat.scala):
See also the examples in [LogFormat.scala](https://github.com/wvlet/airframe/blob/main/airframe-log/shared/src/main/scala/wvlet/log/LogFormat.scala):

### Using airframe-log in Scala.js

Expand Down
4 changes: 2 additions & 2 deletions airspec/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
AirSpec
======

[AirSpec](https://github.com/wvlet/airframe/tree/master/airspec) is a new functional testing framework for Scala and Scala.js.
[AirSpec](https://github.com/wvlet/airframe/tree/main/airspec) is a new functional testing framework for Scala and Scala.js.

AirSpec uses pure Scala functions for writing test cases. This style requires no extra learning cost if you already know Scala. For advanced users, dependency injection to test cases and property-based testing are supported optionally.

- [GitHub: AirSpec](https://github.com/wvlet/airframe/tree/master/airspec)
- [GitHub: AirSpec](https://github.com/wvlet/airframe/tree/main/airspec)
- [Documentation](https://wvlet.org/airframe/docs/airspec)


Expand Down
4 changes: 2 additions & 2 deletions docs/airframe-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: airframe-control: Retry/Rate Control
airframe-control is a colleciton of libraries to manage control flows, that are especially useul for making remote API calls.
For example, airframe-control has exponential back-off retry, jittering, circuit breaker, parallel task execution support, etc.

- [Source Code at GitHub](https://github.com/wvlet/airframe/tree/master/airframe-control)
- [Source Code at GitHub](https://github.com/wvlet/airframe/tree/main/airframe-control)

# Usage

Expand Down Expand Up @@ -210,7 +210,7 @@ val result = source.parallel.withParallelism(4).map { i =>
}
```

You can monitor metrics of parallel execution via JMX using [airframe-jmx](https://github.com/wvlet/airframe/tree/master/airframe-jmx).
You can monitor metrics of parallel execution via JMX using [airframe-jmx](https://github.com/wvlet/airframe/tree/main/airframe-jmx).

```scala
JMXAgent.defaultAgent.register[Parallel.ParallelExecutionStats](Parallel.jmxStats)
Expand Down
6 changes: 3 additions & 3 deletions docs/airframe-di-legacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -656,7 +656,7 @@ While debugging the code in your test cases, you can also use `log-test.properti
```
wvlet.airframe=debug
```
See [airframe-log configuration](https://github.com/wvlet/airframe/blob/master/log/README.md#configuring-log-levels) for the details of log level configurations.
See [airframe-log configuration](https://github.com/wvlet/airframe/blob/main/log/README.md#configuring-log-levels) for the details of log level configurations.


Then you will see the log messages that show the object bindings and injection activities:
Expand Down Expand Up @@ -1029,7 +1029,7 @@ val app: App =
}.apply(session)
```

To generate the above code, Airframe is using [Scala Macros](http://docs.scala-lang.org/overviews/macros/overview.html). You can find the actual macro definitions in [AirframeMacros.scala](https://github.com/wvlet/airframe/blob/master/airframe-macros/shared/src/main/scala/wvlet/airframe/AirframeMacros.scala)
To generate the above code, Airframe is using [Scala Macros](http://docs.scala-lang.org/overviews/macros/overview.html). You can find the actual macro definitions in [AirframeMacros.scala](https://github.com/wvlet/airframe/blob/main/airframe-macros/shared/src/main/scala/wvlet/airframe/AirframeMacros.scala)

When `bind[X]` is called, the active session must be found. So if you try to instantiate A without using `session.build[A]`, `MISSING_SESSION` runtime-error will be thrown:

Expand Down Expand Up @@ -1122,7 +1122,7 @@ session.get(Surface.of[X])

### Surface

Airframe uses `Surface.of[X]` as identifiers of object types. [Surface](https://github.com/wvlet/airframe/tree/master/surface) is an object type inspection library.
Airframe uses `Surface.of[X]` as identifiers of object types. [Surface](https://github.com/wvlet/airframe/tree/main/surface) is an object type inspection library.

Here are some examples of Surface:
```scala
Expand Down
4 changes: 2 additions & 2 deletions docs/airframe-di.md
Original file line number Diff line number Diff line change
Expand Up @@ -538,7 +538,7 @@ While debugging the code in your test cases, you can also use `log-test.properti
```
wvlet.airframe.di=debug
```
See [airframe-log configuration](https://github.com/wvlet/airframe/blob/master/log/README.md#configuring-log-levels) for the details of log level configurations.
See [airframe-log configuration](https://github.com/wvlet/airframe/blob/main/log/README.md#configuring-log-levels) for the details of log level configurations.


Then you will see the log messages that show the object bindings and injection activities:
Expand Down Expand Up @@ -756,7 +756,7 @@ session.get(Surface.of[X])

### Surface

Airframe uses `Surface.of[X]` as identifiers of object types. [Surface](https://github.com/wvlet/airframe/tree/master/surface) is an object type inspection library.
Airframe uses `Surface.of[X]` as identifiers of object types. [Surface](https://github.com/wvlet/airframe/tree/main/surface) is an object type inspection library.

Here are some examples of Surface:
```scala
Expand Down
2 changes: 1 addition & 1 deletion docs/airframe-http.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ server.start { server =>
}
```

See also the examples in [here](https://github.com/wvlet/airframe/blob/master/airframe-http-finagle/src/test/scala/wvlet/airframe/http/finagle/FinagleServerFactoryTest.scala)
See also the examples in [here](https://github.com/wvlet/airframe/blob/main/airframe-http-finagle/src/test/scala/wvlet/airframe/http/finagle/FinagleServerFactoryTest.scala)

## Integration with Airframe DI

Expand Down
6 changes: 3 additions & 3 deletions docs/airframe-log.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ airframe-log also supports [Scala.js](https://www.scala-js.org/) to see the logs

![image](https://wvlet.org/airframe/img/airframe-log/scalajs-formatters.png)

- GitHub: [airframe-log](https://github.com/wvlet/airframe/tree/master/airframe-log)
- GitHub: [airframe-log](https://github.com/wvlet/airframe/tree/main/airframe-log)
- Blog post: [Airframe Log: A Modern Logging Library for Scala](https://medium.com/@taroleo/airframe-log-a-modern-logging-library-for-scala-56fbc2f950bc)


Expand Down Expand Up @@ -134,7 +134,7 @@ call `Logger.scheduleLogLevelScan` before running test cases. This is useful for

To scan log level properties periodically with [ScalaTest](http://www.scalatest.org/), define the base trait as follows:

**[Spec.scala](https://github.com/wvlet/log/blob/master/src/test/scala/wvlet/log/Spec.scala)**
**[Spec.scala](https://github.com/wvlet/log/blob/main/src/test/scala/wvlet/log/Spec.scala)**
```scala
import org.scalatest.{BeforeAndAfter, BeforeAndAfterAll, WordSpec, _}
import wvlet.log.LogFormatter.SourceCodeLogFormatter
Expand Down Expand Up @@ -206,7 +206,7 @@ object CustomLogFormatter extends LogFormatter {

Logger.setDefaultFormatter(CustomLogFormatter)
```
See also the examples in [LogFormat.scala](https://github.com/wvlet/airframe/blob/master/airframe-log/shared/src/main/scala/wvlet/log/LogFormat.scala):
See also the examples in [LogFormat.scala](https://github.com/wvlet/airframe/blob/main/airframe-log/shared/src/main/scala/wvlet/log/LogFormat.scala):

### Using airframe-log in Scala.js

Expand Down
2 changes: 1 addition & 1 deletion docs/airframe-parquet.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ reader.close()
## Applying Row Group Filter with Parquet FilterApi

Parquet can skip reading records by using row group filters.
You can use [FilterAPI of parquet-mr](https://github.com/justcodeforfun/parquet-mr/blob/master/parquet-column/src/main/java/org/apache/parquet/filter2/predicate/FilterApi.java) to build such a filter:
You can use [FilterAPI of parquet-mr](https://github.com/justcodeforfun/parquet-mr/blob/main/parquet-column/src/main/java/org/apache/parquet/filter2/predicate/FilterApi.java) to build such a filter:

```scala
import org.apache.parquet.filter2.compat.FilterCompat
Expand Down
12 changes: 6 additions & 6 deletions docs/airframe-rpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ Supported client types are:
- __async__: (legacy client. Use rpc instead) Create an async HTTP client (ServiceClient) for Scala (JVM) using Future
abstraction (`F`). The `F` can be `scala.concurrent.Future` or twitter-util's Future.

Internally, sbt-airframe generates these clients using [HTTP code generators](https://github.com/wvlet/airframe/blob/master/airframe-http-codegen/src/main/scala/wvlet/airframe/http/codegen/client/ScalaHttpClientGenerator.scala). This code reads a Router definition of RPC interfaces, and generate client code for calling RPC endpoints. Currently, we only supports generating HTTP clients for Scala. In near future, we would
Internally, sbt-airframe generates these clients using [HTTP code generators](https://github.com/wvlet/airframe/blob/main/airframe-http-codegen/src/main/scala/wvlet/airframe/http/codegen/client/ScalaHttpClientGenerator.scala). This code reads a Router definition of RPC interfaces, and generate client code for calling RPC endpoints. Currently, we only supports generating HTTP clients for Scala. In near future, we would
like to add Open API spec generator so that many programming languages can be used with Airframe
RPC.

Expand Down Expand Up @@ -522,7 +522,7 @@ trait MyAPI {

### Reporting Errors with RPCStatus

Airframe RPC provides predefined [RPCStatus](https://github.com/wvlet/airframe/blob/master/airframe-http/src/main/scala/wvlet/airframe/http/RPCStatus.scala) code for reporting application errors at ease. In your RPC implementation, use one of the RPCStatus codes and create an exception with `.newException(...)` method to report an error:
Airframe RPC provides predefined [RPCStatus](https://github.com/wvlet/airframe/blob/main/airframe-http/src/main/scala/wvlet/airframe/http/RPCStatus.scala) code for reporting application errors at ease. In your RPC implementation, use one of the RPCStatus codes and create an exception with `.newException(...)` method to report an error:


```scala
Expand Down Expand Up @@ -594,7 +594,7 @@ val rpcClient = ServiceRPC.newSyncClient(httpClient)

### Reading RPCException at the client

To read the RPCStatus and error details at the RPC client side, catch [RPCException](https://github.com/wvlet/airframe/blob/master/airframe-http/src/main/scala/wvlet/airframe/http/RPCException.scala):
To read the RPCStatus and error details at the RPC client side, catch [RPCException](https://github.com/wvlet/airframe/blob/main/airframe-http/src/main/scala/wvlet/airframe/http/RPCException.scala):

```scala
try {
Expand All @@ -621,7 +621,7 @@ RPC calls per second. Airframe gRPC requires no Protobuf definitions. You can us
interface and case classes to define gRPC services.

Example gRPC projects can be found
from [here](https://github.com/wvlet/airframe/tree/master/examples/rpc-examples).
from [here](https://github.com/wvlet/airframe/tree/main/examples/rpc-examples).

__build.sbt__

Expand Down Expand Up @@ -825,7 +825,7 @@ request message body of an RPC request is a MessagePack Map representation of a
key-value pairs of `(method argument name)` -> `(method argument value)`.

When gRPC backend is used, the client must use HTTP/2 and the message body must be encoded
as [Length-Prefixed-Message](https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md#requests)
as [Length-Prefixed-Message](https://github.com/grpc/grpc/blob/main/doc/PROTOCOL-HTTP2.md#requests)
defined in gRPC protocol.

### RPC Protocol
Expand Down Expand Up @@ -886,7 +886,7 @@ case class HelloResponse(message: String)
### RPC Protocol (HTTP/2 for gRPC)

For gRPC backend, see
also [gRPC over HTTP2](https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md) protocol for
also [gRPC over HTTP2](https://github.com/grpc/grpc/blob/main/doc/PROTOCOL-HTTP2.md) protocol for
the other HTTP headers.

```aidl
Expand Down
2 changes: 1 addition & 1 deletion docs/airframe-rx.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: airframe-rx: ReactiveX interface

airframe-rx is a lightweight [ReactiveX](http://reactivex.io/) implementation for Scala and Scala.js, which can be used for:
- Streaming support of [Airframe gRPC](airframe-rpc.md)
- [Interactive rendering of DOM objects](https://github.com/wvlet/airframe/blob/master/airframe-http-rx/.js/src/main/scala/wvlet/airframe/http/rx/html/DOMRenderer.scala) (airframe-http-rx)
- [Interactive rendering of DOM objects](https://github.com/wvlet/airframe/blob/main/airframe-http-rx/.js/src/main/scala/wvlet/airframe/http/rx/html/DOMRenderer.scala) (airframe-http-rx)
- etc.


Expand Down
4 changes: 2 additions & 2 deletions docs/airframe-ulid.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Uses Crockford's base32 for better efficiency and readability (5 bits per charac
- No special characters (URL safe)
- Monotonic sort order (correctly detects and handles the same millisecond)

[Source code of airframe-ulid at GitHub](https://github.com/wvlet/airframe/tree/master/airframe-ulid)
[Source code of airframe-ulid at GitHub](https://github.com/wvlet/airframe/tree/main/airframe-ulid)

## ULID Format

Expand Down Expand Up @@ -141,7 +141,7 @@ Comparison targets:
- [scala-ulid (by Chatwork)](https://github.com/chatwork/scala-ulid)
- Java's UUID.randomUUID()

[Benchmark code](https://github.com/wvlet/airframe/blob/master/airframe-benchmark/src/main/scala/wvlet/airframe/benchmark/ulid/ULIDBenchmark.scala) using JMH.
[Benchmark code](https://github.com/wvlet/airframe/blob/main/airframe-benchmark/src/main/scala/wvlet/airframe/benchmark/ulid/ULIDBenchmark.scala) using JMH.


### Scala.js-specific Note
Expand Down
Loading

0 comments on commit a7f5638

Please sign in to comment.