Skip to content

Commit 3c567c0

Browse files
authored
Pekko becomes a TLP (apache#520)
1 parent e419584 commit 3c567c0

File tree

33 files changed

+76
-87
lines changed

33 files changed

+76
-87
lines changed

.github/ISSUE_TEMPLATE/---bug-report.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ about: Create a report to help us improve
66

77
<!--
88
Please report issues regarding specific projects in their respective issue trackers, e.g.:
9-
- Pekko: https://github.com/apache/incubator-pekko/issues
10-
- Pekko Connectors: https://github.com/apache/incubator-pekko-connectors/issues
11-
- Pekko Persistence Cassandra Plugin: https://github.com/apache/incubator-pekko-persistence-cassandra/issues
9+
- Pekko: https://github.com/apache/pekko/issues
10+
- Pekko Connectors: https://github.com/apache/pekko-connectors/issues
11+
- Pekko Persistence Cassandra Plugin: https://github.com/apache/pekko-persistence-cassandra/issues
1212
- ...
1313
1414
Please explain your issue precisely, and if possible provide a reproducer snippet (this helps resolve issues much quicker).

.github/ISSUE_TEMPLATE/---feature-request.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ about: Suggest an idea for this project
66

77
<!--
88
Please report issues regarding specific projects in their respective issue trackers, e.g.:
9-
- Pekko: https://github.com/apache/incubator-pekko/issues
10-
- Pekko Connectors: https://github.com/apache/incubator-pekko-connectors/issues
11-
- Pekko Persistence Cassandra Plugin: https://github.com/apache/incubator-pekko-persistence-cassandra/issues
9+
- Pekko: https://github.com/apache/pekko/issues
10+
- Pekko Connectors: https://github.com/apache/pekko-connectors/issues
11+
- Pekko Persistence Cassandra Plugin: https://github.com/apache/pekko-persistence-cassandra/issues
1212
- ...
1313
1414
Please explain your issue precisely, and if possible provide a reproducer snippet (this helps resolve issues much quicker).

.github/workflows/format.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
build:
1111
name: Code is formatted
1212
runs-on: ubuntu-latest
13-
if: github.repository == 'apache/incubator-pekko-http'
13+
if: github.repository == 'apache/pekko-http'
1414
steps:
1515
- name: Checkout current branch (full)
1616
uses: actions/checkout@v4

.github/workflows/link-validator.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ on:
1111
jobs:
1212
validate-links:
1313
runs-on: ubuntu-20.04
14-
if: github.repository == 'apache/incubator-pekko-http'
14+
if: github.repository == 'apache/pekko-http'
1515
steps:
1616
- name: Checkout
1717
uses: actions/checkout@v4
@@ -22,7 +22,7 @@ jobs:
2222
git fetch origin pull/${{ github.event.pull_request.number }}/merge:scratch
2323
git checkout scratch
2424
25-
# needs Java 8, see https://github.com/apache/incubator-pekko-http/pull/204#discussion_r1265279415
25+
# needs Java 8, see https://github.com/apache/pekko-http/pull/204#discussion_r1265279415
2626
- name: Setup Java 8
2727
uses: actions/setup-java@v4
2828
with:

.github/workflows/nightly.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ jobs:
99
compile-and-test:
1010
name: Compile and test
1111
runs-on: ubuntu-latest
12-
if: github.repository == 'apache/incubator-pekko-http'
12+
if: github.repository == 'apache/pekko-http'
1313
strategy:
1414
fail-fast: false
1515
matrix:

.github/workflows/publish-1.0-docs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424
publish-docs:
2525
name: Publish documentation to nightlies.apache.org
2626
runs-on: ubuntu-latest
27-
if: github.repository == 'apache/incubator-pekko-http'
27+
if: github.repository == 'apache/pekko-http'
2828
steps:
2929
- name: Checkout
3030
uses: actions/checkout@v4

.github/workflows/publish-1.0-snapshots.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ jobs:
99
publish-artifacts:
1010
name: Publish 1.0 artifacts to Apache Nexus
1111
runs-on: ubuntu-latest
12-
if: github.repository == 'apache/incubator-pekko-http'
12+
if: github.repository == 'apache/pekko-http'
1313
steps:
1414
- name: Checkout
1515
uses: actions/checkout@v4

.github/workflows/publish-test-reports.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
publish-test-results:
1111
name: "Publish details with dorny-test-reporter"
1212
runs-on: ubuntu-latest
13-
if: github.repository == 'apache/incubator-pekko-http'
13+
if: github.repository == 'apache/pekko-http'
1414
strategy:
1515
fail-fast: false
1616
matrix:

.github/workflows/publish.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ jobs:
99
publish-artifacts:
1010
name: Publish artifacts to Apache Nexus
1111
runs-on: ubuntu-latest
12-
if: github.repository == 'apache/incubator-pekko-http'
12+
if: github.repository == 'apache/pekko-http'
1313
steps:
1414
- name: Checkout
1515
uses: actions/checkout@v4
@@ -39,7 +39,7 @@ jobs:
3939
publish-docs:
4040
name: Publish documentation to nightlies.apache.org
4141
runs-on: ubuntu-latest
42-
if: github.repository == 'apache/incubator-pekko-http'
42+
if: github.repository == 'apache/pekko-http'
4343
steps:
4444
- name: Checkout
4545
uses: actions/checkout@v4

.github/workflows/validate-and-test.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
formatting-check:
1616
name: Checks
1717
runs-on: ubuntu-latest
18-
if: github.repository == 'apache/incubator-pekko-http'
18+
if: github.repository == 'apache/pekko-http'
1919
steps:
2020
- name: Checkout
2121
uses: actions/checkout@v4
@@ -45,7 +45,7 @@ jobs:
4545
run: git diff --exit-code --color
4646

4747
#- name: FOSSA policy check
48-
# if: ${{ github.event_name == 'push' || github.event.pull_request.head.repo.full_name == 'apache/incubator-pekko-http' }}
48+
# if: ${{ github.event_name == 'push' || github.event.pull_request.head.repo.full_name == 'apache/pekko-http' }}
4949
# run: |-
5050
# curl -H 'Cache-Control: no-cache' https://raw.githubusercontent.com/fossas/spectrometer/master/install.sh | bash
5151
# fossa analyze && fossa test
@@ -55,7 +55,7 @@ jobs:
5555
compile-and-test:
5656
name: Compile and test
5757
runs-on: ubuntu-latest
58-
if: github.repository == 'apache/incubator-pekko-http'
58+
if: github.repository == 'apache/pekko-http'
5959
strategy:
6060
fail-fast: false
6161
matrix:

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ The [Release Notes](https://pekko.apache.org/docs/pekko-http/current/release-not
66

77
GitHub has a feature allowing you to compare 2 Git tags and see the PRs and overall code diff. You can take the example URL below and tweak it with the version tags that you want to compare.
88

9-
https://github.com/apache/incubator-pekko-http/compare/v1.0.0...v1.0.1-RC1
9+
https://github.com/apache/pekko-http/compare/v1.0.0...v1.0.1-RC1

CONTRIBUTING.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -22,36 +22,36 @@ Pekko HTTP uses tags to categorise issues into groups or mark their phase in dev
2222

2323
Most notably many tags start `t:` prefix (as in `topic:`), which categorises issues in terms of which module they relate to. Examples are:
2424

25-
- [t:http:core](https://github.com/apache/incubator-pekko-http/issues?q=is%3Aopen+is%3Aissue+label%3At%3Ahttp%3Acore)
26-
- [t:server:dsl](https://github.com/apache/incubator-pekko-http/issues?q=is%3Aopen+is%3Aissue+label%3At%3Ahttp%3Aserver%3Adsl)
27-
- see [all tags here](https://github.com/apache/incubator-pekko-http/labels)
25+
- [t:http:core](https://github.com/apache/pekko-http/issues?q=is%3Aopen+is%3Aissue+label%3At%3Ahttp%3Acore)
26+
- [t:server:dsl](https://github.com/apache/pekko-http/issues?q=is%3Aopen+is%3Aissue+label%3At%3Ahttp%3Aserver%3Adsl)
27+
- see [all tags here](https://github.com/apache/pekko-http/labels)
2828

2929
In general *all issues are open for anyone working on them*, however if you're new to the project and looking for an issue
3030
that will be accepted and likely is a nice one to get started you should check out the following tags:
3131

32-
- [help wanted](https://github.com/apache/incubator-pekko-http/labels/help%20wanted) - which identifies issues that the core team will likely not have time to work on, or the issue is a nice entry level ticket. If you're not sure how to solve a ticket but would like to work on it feel free to ask in the issue about clarification or tips.
33-
- [nice-to-have (low-priority)](https://github.com/apache/incubator-pekko-http/labels/nice-to-have%20%28low-prio%29) - are tasks which make sense, however are not very high priority (in face of other very high priority issues). If you see something interesting in this list, a contribution would be really wonderful!
32+
- [help wanted](https://github.com/apache/pekko-http/labels/help%20wanted) - which identifies issues that the core team will likely not have time to work on, or the issue is a nice entry level ticket. If you're not sure how to solve a ticket but would like to work on it feel free to ask in the issue about clarification or tips.
33+
- [nice-to-have (low-priority)](https://github.com/apache/pekko-http/labels/nice-to-have%20%28low-prio%29) - are tasks which make sense, however are not very high priority (in face of other very high priority issues). If you see something interesting in this list, a contribution would be really wonderful!
3434

3535
Another group of tickets are those which start from a number. They're used to signal in what phase of development an issue is:
3636

37-
- [0 - new](https://github.com/apache/incubator-pekko-http/labels/0%20-%20new) - is assigned when a ticket is unclear on it's purpose or if it is valid or not. Sometimes the additional tag `discuss` is used to mark such tickets, if they propose large scale changed and need more discussion before moving into triaged (or being closed as invalid)
38-
- [1 - triaged](https://github.com/apache/incubator-pekko-http/labels/1%20-%20triaged) - roughly speaking means "this ticket makes sense". Triaged tickets are safe to pick up for contributing in terms of likeliness of a patch for it being accepted. It is not recommended to start working on a ticket that is not triaged.
39-
- [2 - pick next](https://github.com/apache/incubator-pekko-http/labels/2%20-%20pick%20next) - used to mark issues which are next up in the queue to be worked on. Sometimes it's also used to mark which PRs are expected to be reviewed/merged for the next release. The tag is non-binding, and mostly used as organisational helper.
40-
- [3 - in progress](https://github.com/apache/incubator-pekko-http/labels/3%20-%20in%20progress) - means someone is working on this ticket. If you see a ticket that has the tag, however seems inactive, it could have been an omission with removing the tag, feel free to ping the ticket then if it's still being worked on.
37+
- [0 - new](https://github.com/apache/pekko-http/labels/0%20-%20new) - is assigned when a ticket is unclear on it's purpose or if it is valid or not. Sometimes the additional tag `discuss` is used to mark such tickets, if they propose large scale changed and need more discussion before moving into triaged (or being closed as invalid)
38+
- [1 - triaged](https://github.com/apache/pekko-http/labels/1%20-%20triaged) - roughly speaking means "this ticket makes sense". Triaged tickets are safe to pick up for contributing in terms of likeliness of a patch for it being accepted. It is not recommended to start working on a ticket that is not triaged.
39+
- [2 - pick next](https://github.com/apache/pekko-http/labels/2%20-%20pick%20next) - used to mark issues which are next up in the queue to be worked on. Sometimes it's also used to mark which PRs are expected to be reviewed/merged for the next release. The tag is non-binding, and mostly used as organisational helper.
40+
- [3 - in progress](https://github.com/apache/pekko-http/labels/3%20-%20in%20progress) - means someone is working on this ticket. If you see a ticket that has the tag, however seems inactive, it could have been an omission with removing the tag, feel free to ping the ticket then if it's still being worked on.
4141

4242
The last group of special tags indicate specific states a ticket is in:
4343

44-
- [bug](https://github.com/apache/incubator-pekko-http/labels/bug) - bugs take priority in being fixed above features. The core team dedicates a number of days to working on bugs each sprint. Bugs which have reproducers are also great for community contributions as they're well isolated. Sometimes we're not as lucky to have reproducers though, then a bugfix should also include a test reproducing the original error along with the fix.
45-
- [failed](https://github.com/apache/incubator-pekko-http/labels/failed) - tickets indicate a Jenkins failure (for example from a nightly build). These tickets usually start with the `FAILED: ...` message, and include a stacktrace + link to the Jenkins failure. The tickets are collected and worked on with priority to keep the build stable and healthy. Often times it may be simple timeout issues (Jenkins boxes are slow), though sometimes real bugs are discovered this way.
44+
- [bug](https://github.com/apache/pekko-http/labels/bug) - bugs take priority in being fixed above features. The core team dedicates a number of days to working on bugs each sprint. Bugs which have reproducers are also great for community contributions as they're well isolated. Sometimes we're not as lucky to have reproducers though, then a bugfix should also include a test reproducing the original error along with the fix.
45+
- [failed](https://github.com/apache/pekko-http/labels/failed) - tickets indicate a Jenkins failure (for example from a nightly build). These tickets usually start with the `FAILED: ...` message, and include a stacktrace + link to the Jenkins failure. The tickets are collected and worked on with priority to keep the build stable and healthy. Often times it may be simple timeout issues (Jenkins boxes are slow), though sometimes real bugs are discovered this way.
4646

4747
Pull Request validation states:
4848

4949
- `validating => [tested | needs-attention]` - signify pull request validation status
5050

5151
# Pekko HTTP contributing guidelines
5252

53-
These guidelines apply to all Apache Pekko projects, by which we mean both the `apache/incubator-pekko` repository,
54-
as well as any plugins or additional repos located under the Pekko GitHub organisation, e.g. `apache/incubator-pekko-http` and others.
53+
These guidelines apply to all Apache Pekko projects, by which we mean both the `apache/pekko` repository,
54+
as well as any plugins or additional repos located under the Pekko GitHub organisation, e.g. `apache/pekko-http` and others.
5555

5656
These guidelines are meant to be a living document that should be changed and adapted as needed.
5757
We encourage changes that make it easier to achieve our goals in an efficient way.
@@ -64,9 +64,9 @@ You can read its full text here: [ASF Code of Conduct](https://www.apache.org/fo
6464
The below steps are how to get a patch into a `main` development branch.
6565
The steps are exactly the same for everyone involved in the project (be it core team, or first time contributor).
6666

67-
1. To avoid duplicated effort, it might be good to check the [issue tracker](https://github.com/apache/incubator-pekko-http/issues) and [existing pull requests](https://github.com/apache/incubator-pekko-http/pulls) for existing work.
68-
- If there is no ticket yet, feel free to [create one](https://github.com/apache/incubator-pekko-http/issues/new) to discuss the problem and the approach you want to take to solve it.
69-
1. [Fork the project](https://github.com/apache/incubator-pekko-http#fork-destination-box) on GitHub. You'll need to create a feature-branch for your work on your fork, as this way you'll be able to submit a PullRequest against the mainline Pekko HTTP.
67+
1. To avoid duplicated effort, it might be good to check the [issue tracker](https://github.com/apache/pekko-http/issues) and [existing pull requests](https://github.com/apache/pekko-http/pulls) for existing work.
68+
- If there is no ticket yet, feel free to [create one](https://github.com/apache/pekko-http/issues/new) to discuss the problem and the approach you want to take to solve it.
69+
1. [Fork the project](https://github.com/apache/pekko-http#fork-destination-box) on GitHub. You'll need to create a feature-branch for your work on your fork, as this way you'll be able to submit a PullRequest against the mainline Pekko HTTP.
7070
1. Create a branch on your fork and work on the feature. For example: `git checkout -b wip-custom-headers-pekko-http`
7171
- Please make sure to follow the general quality guidelines (specified below) when developing your patch.
7272
- Please write additional tests covering your feature and adjust existing ones if needed before submitting your Pull Request. The `validatePullRequest` sbt task ([explained below](#the-validatepullrequest-task)) may come in handy to verify your changes are correct.
@@ -83,7 +83,7 @@ The steps are exactly the same for everyone involved in the project (be it core
8383

8484
The TL;DR; of the above very precise workflow version is:
8585

86-
1. Fork incubator-pekko-http
86+
1. Fork pekko-http
8787
2. Hack and test on your feature (on a branch)
8888
3. Submit a PR
8989
4. Sign the ASF CLA if necessary
@@ -319,7 +319,7 @@ There is a number of ways timeouts can be defined in Pekko tests. The following
319319

320320
Special care should be given `expectNoMessage` calls, which indeed will wait the entire timeout before continuing, therefore a shorter timeout should be used in those, for example `200` or `300.millis`.
321321

322-
You can read up on remaining and friends in [TestKit.scala](https://github.com/apache/incubator-pekko/blob/main/pekko-testkit/src/main/scala/org/apache/pekko/testkit/TestKit.scala)
322+
You can read up on remaining and friends in [TestKit.scala](https://github.com/apache/pekko/blob/main/pekko-testkit/src/main/scala/org/apache/pekko/testkit/TestKit.scala)
323323

324324
# Supporting infrastructure
325325

@@ -334,7 +334,7 @@ We do not yet publish snapshots.
334334
## Related links
335335

336336
* [Apache Contributor License Agreement](https://www.apache.org/licenses/contributor-agreements.html)
337-
* [Pekko HTTP Issue Tracker](https://github.com/apache/incubator-pekko-http/issues)
337+
* [Pekko HTTP Issue Tracker](https://github.com/apache/pekko-http/issues)
338338
* [Scalariform](https://github.com/scala-ide/scalariform)
339339

340340
# Development tools

DISCLAIMER

-10
This file was deleted.

0 commit comments

Comments
 (0)