Skip to content

Commit

Permalink
Renamed default branch to main, update CI (#2679)
Browse files Browse the repository at this point in the history
This includes links and mention of branches in the reference
guide, and targets 3.3.x for consistency of said guides.

Co-authored-by: Simon Baslé <sbasle@vmware.com>
  • Loading branch information
OlegDokuka and simonbasle authored Apr 22, 2021
1 parent 9308821 commit 601a74a
Show file tree
Hide file tree
Showing 10 changed files with 31 additions and 29 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: publish
on:
push:
branches: # For branches, better to list them explicitly than regexp include
- master
- main
- 3.3.x
jobs:
# General job notes: we DON'T want to cancel any previous runs, especially in the case of a "back to snapshots" build right after a release push
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

[![Download](https://api.bintray.com/packages/spring/jars/io.projectreactor/images/download.svg)](https://bintray.com/spring/jars/io.projectreactor/_latestVersion)

[![Travis CI](https://travis-ci.org/reactor/reactor-core.svg?branch=master)](https://travis-ci.org/reactor/reactor-core)
[![CI on GHA](https://github.com/reactor/reactor-core/actions/workflows/publish.yml/badge.svg)](https://github.com/reactor/reactor-core/actions/workflows/publish.yml)
[![Codecov](https://img.shields.io/codecov/c/github/reactor/reactor-core.svg)]()
[![Code Quality: Java](https://img.shields.io/lgtm/grade/java/g/reactor/reactor-core.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/reactor/reactor-core/context:java)
[![Total Alerts](https://img.shields.io/lgtm/alerts/g/reactor/reactor-core.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/reactor/reactor-core/alerts)
Expand Down
8 changes: 4 additions & 4 deletions docs/asciidoc/aboutDoc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ copy contains this Copyright Notice, whether distributed in print or electronica
== Contributing to the Documentation
The reference guide is written in
https://asciidoctor.org/docs/asciidoc-writers-guide/[Asciidoc], and you can find its sources at
https://github.com/reactor/reactor-core/tree/master/docs/asciidoc.
https://github.com/reactor/reactor-core/tree/main/docs/asciidoc.

If you have an improvement or a suggestion, we will be happy to get a pull request from you!

Expand All @@ -29,7 +29,7 @@ ifeval::["{backend}" == "html5"]
TIP: To facilitate documentation edits, most sections have a link at the end that opens
an edit UI directly on GitHub for the main source file for that section. These links are
only present in the HTML5 version of this reference guide. They look like the following:
link:https://github.com/reactor/reactor-core/edit/master/docs/asciidoc/aboutDoc.adoc[Suggest Edit^, role="fa fa-edit"] to <<about-doc>>.
link:https://github.com/reactor/reactor-core/edit/main/docs/asciidoc/aboutDoc.adoc[Suggest Edit^, role="fa fa-edit"] to <<about-doc>>.
endif::[]

== Getting Help
Expand All @@ -44,9 +44,9 @@ essential features) and https://github.com/reactor/reactor-addons/issues[reactor
(which covers reactor-test and adapters issues).

NOTE: All of Reactor is open source,
https://github.com/reactor/reactor-core/tree/master/docs/asciidoc[including this
https://github.com/reactor/reactor-core/tree/main/docs/asciidoc[including this
documentation]. If you find problems with the docs or if you want to improve them,
please https://github.com/reactor/.github/blob/master/CONTRIBUTING.md[get involved].
please https://github.com/reactor/.github/blob/main/CONTRIBUTING.md[get involved].

== Where to Go from Here
* Head to <<getting-started>> if you feel like jumping straight into the code.
Expand Down
4 changes: 2 additions & 2 deletions docs/asciidoc/gettingStarted.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,6 @@ repositories {
[[support]]
== Support and policies

The entries below are mirroring https://github.com/reactor/.github/blob/master/SUPPORT.adoc
The entries below are mirroring https://github.com/reactor/.github/blob/main/SUPPORT.adoc

include::https://raw.githubusercontent.com/reactor/.github/master/SUPPORT.adoc[leveloffset=3]
include::https://raw.githubusercontent.com/reactor/.github/main/SUPPORT.adoc[leveloffset=3]
2 changes: 1 addition & 1 deletion docs/asciidoc/highlight/CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -699,7 +699,7 @@ We're going to redesign the old [demo/test suite][demo] into an interactive
demo web app. If you're confident front-end developer or designer and want to
help us with it, drop a comment into [the issue][#542] on GitHub.

[test]: https://github.com/isagalaev/highlight.js/tree/master/test
[test]: https://github.com/isagalaev/highlight.js/tree/main/test
[demo]: https://highlightjs.org/static/test.html
[#542]: https://github.com/isagalaev/highlight.js/issues/542
[ci]: https://travis-ci.org/isagalaev/highlight.js
Expand Down
7 changes: 4 additions & 3 deletions docs/asciidoc/highlight/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Highlight.js

[![Build Status](https://travis-ci.org/isagalaev/highlight.js.svg?branch=master)](https://travis-ci.org/isagalaev/highlight.js)
[![Build Status](https://travis-ci.org/isagalaev/highlight.js.svg?branch=main)]
(https://travis-ci.org/isagalaev/highlight.js)

Highlight.js is a syntax highlighter written in JavaScript. It works in
the browser as well as on the server. It works with pretty much any
Expand Down Expand Up @@ -146,5 +147,5 @@ Authors and contributors are listed in the [AUTHORS.en.txt][8] file.
[4]: https://highlightjs.readthedocs.io/en/latest/api.html#configure-options
[5]: https://highlightjs.org/download/
[6]: https://highlightjs.readthedocs.io/en/latest/building-testing.html
[7]: https://github.com/isagalaev/highlight.js/blob/master/LICENSE
[8]: https://github.com/isagalaev/highlight.js/blob/master/AUTHORS.en.txt
[7]: https://github.com/isagalaev/highlight.js/blob/main/LICENSE
[8]: https://github.com/isagalaev/highlight.js/blob/main/AUTHORS.en.txt
4 changes: 2 additions & 2 deletions docs/asciidoc/highlight/README.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,5 +138,5 @@ Highlight.js распространяется под лицензией BSD. П
[4]: https://highlightjs.readthedocs.io/en/latest/api.html#configure-options
[5]: https://highlightjs.org/download/
[6]: https://highlightjs.readthedocs.io/en/latest/building-testing.html
[7]: https://github.com/isagalaev/highlight.js/blob/master/LICENSE
[8]: https://github.com/isagalaev/highlight.js/blob/master/AUTHORS.ru.txt
[7]: https://github.com/isagalaev/highlight.js/blob/main/LICENSE
[8]: https://github.com/isagalaev/highlight.js/blob/main/AUTHORS.ru.txt
26 changes: 13 additions & 13 deletions docs/asciidoc/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,86 +9,86 @@ ifndef::host-github[:ext-relative: {outfilesuffix}]

include::aboutDoc.adoc[leveloffset=1]
ifeval::["{backend}" == "html5"]
https://github.com/reactor/reactor-core/edit/master/docs/asciidoc/aboutDoc.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
https://github.com/reactor/reactor-core/edit/main/docs/asciidoc/aboutDoc.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
to "<<about-doc>>"
endif::[]

include::gettingStarted.adoc[leveloffset=1]
ifeval::["{backend}" == "html5"]
https://github.com/reactor/reactor-core/edit/master/docs/asciidoc/gettingStarted.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
https://github.com/reactor/reactor-core/edit/main/docs/asciidoc/gettingStarted.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
to "<<getting-started>>"
endif::[]

include::reactiveProgramming.adoc[leveloffset=1]
ifeval::["{backend}" == "html5"]
https://github.com/reactor/reactor-core/edit/master/docs/asciidoc/reactiveProgramming.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
https://github.com/reactor/reactor-core/edit/main/docs/asciidoc/reactiveProgramming.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
to "<<intro-reactive>>"
endif::[]

include::coreFeatures.adoc[leveloffset=1]
ifeval::["{backend}" == "html5"]
https://github.com/reactor/reactor-core/edit/master/docs/asciidoc/coreFeatures.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
https://github.com/reactor/reactor-core/edit/main/docs/asciidoc/coreFeatures.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
to "<<core-features>>"
endif::[]

//TODO see other sections from consuming.adoc

include::kotlin.adoc[leveloffset=1]
ifeval::["{backend}" == "html5"]
https://github.com/reactor/reactor-core/edit/master/docs/asciidoc/kotlin.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
https://github.com/reactor/reactor-core/edit/main/docs/asciidoc/kotlin.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
to "<<kotlin>>"
endif::[]

include::testing.adoc[leveloffset=1]
ifeval::["{backend}" == "html5"]
https://github.com/reactor/reactor-core/edit/master/docs/asciidoc/testing.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
https://github.com/reactor/reactor-core/edit/main/docs/asciidoc/testing.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
to "<<testing>>"
endif::[]

include::debugging.adoc[leveloffset=1]
ifeval::["{backend}" == "html5"]
https://github.com/reactor/reactor-core/edit/master/docs/asciidoc/debugging.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
https://github.com/reactor/reactor-core/edit/main/docs/asciidoc/debugging.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
to "<<debugging>>"
endif::[]

include::metrics.adoc[leveloffset=1]
ifeval::["{backend}" == "html5"]
https://github.com/reactor/reactor-core/edit/master/docs/asciidoc/metrics.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
https://github.com/reactor/reactor-core/edit/main/docs/asciidoc/metrics.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
to "<<metrics>>"
endif::[]

include::advancedFeatures.adoc[leveloffset=1]
ifeval::["{backend}" == "html5"]
https://github.com/reactor/reactor-core/edit/master/docs/asciidoc/advancedFeatures.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
https://github.com/reactor/reactor-core/edit/main/docs/asciidoc/advancedFeatures.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
to "<<advanced>>"
endif::[]


[appendix]
include::apdx-operatorChoice.adoc[leveloffset=1]
ifeval::["{backend}" == "html5"]
https://github.com/reactor/reactor-core/edit/master/docs/asciidoc/apdx-operatorChoice.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
https://github.com/reactor/reactor-core/edit/main/docs/asciidoc/apdx-operatorChoice.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
to "<<which-operator>>"
endif::[]

[appendix]
include::apdx-howtoReadMarbles.adoc[leveloffset=1]
ifeval::["{backend}" == "html5"]
https://github.com/reactor/reactor-core/edit/master/docs/asciidoc/apdx-howtoReadMarbles.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
https://github.com/reactor/reactor-core/edit/main/docs/asciidoc/apdx-howtoReadMarbles.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
to "<<howtoReadMarbles>>"
endif::[]

[appendix]
include::faq.adoc[leveloffset=1]
ifeval::["{backend}" == "html5"]
https://github.com/reactor/reactor-core/edit/master/docs/asciidoc/faq.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
https://github.com/reactor/reactor-core/edit/main/docs/asciidoc/faq.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
to "<<faq>>"
endif::[]

[appendix]
include::apdx-reactorExtra.adoc[leveloffset=1]
ifeval::["{backend}" == "html5"]
https://github.com/reactor/reactor-core/edit/master/docs/asciidoc/apdx-reactorExtra.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
https://github.com/reactor/reactor-core/edit/main/docs/asciidoc/apdx-reactorExtra.adoc[Suggest Edit^, title="Suggest an edit to the above section via github", role="fa fa-edit"]
to "<<reactor-extra>>"
endif::[]

Expand Down
3 changes: 2 additions & 1 deletion docs/asciidoc/processors.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,8 @@ draining it.
TIP: One way of publishing events onto different threads is to use the `EmitterProcessor`
combined with `publishOn(Scheduler)`. This can for example replace the former `TopicProcessor`,
which was using `Unsafe` operations and has been moved to
https://github.com/reactor/reactor-addons/tree/master/reactor-extra/src/main/java/reactor/extra/processor[reactor-extra]
https://github.com/reactor/reactor-addons/tree/main/reactor-extra/src/main/java/reactor
/extra/processor[reactor-extra]
in 3.3.0.

== Direct Processor
Expand Down
2 changes: 1 addition & 1 deletion docs/asciidoc/testing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ automated testing is always a good idea.

Reactor comes with a few elements dedicated to testing, gathered into their own
artifact: `reactor-test`. You can find that project
https://github.com/reactor/reactor-core/tree/master/reactor-test/src[on Github],
https://github.com/reactor/reactor-core/tree/main/reactor-test/src[on Github],
inside of the `reactor-core` repository.

To use it in your tests, you must add it as a test dependency.
Expand Down

0 comments on commit 601a74a

Please sign in to comment.