Skip to content

Commit 8d54f9c

Browse files
vyvy
committed
Update logging-parent to version 11.0.0 and migrate to Antora (apache/logging-log4j2#2443)
1 parent 4b7a7ed commit 8d54f9c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+583
-516
lines changed

‎.asf.yaml

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,6 @@
1717

1818
# `.asf.yaml` documentation: https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features
1919

20-
notifications:
21-
# GitHub already provides notifications for PRs and issues.
22-
# Please don't duplicate that noise here!
23-
commits: commits@logging.apache.org
24-
issues: notifications@logging.apache.org
25-
pullrequests: notifications@logging.apache.org
26-
pullrequests_bot_dependabot: robots@logging.apache.org
27-
2820
github:
2921

3022
description: "Jakarta-specific Apache Log4j components"

‎.github/dependabot.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@
1616
#
1717
version: 2
1818

19-
# Add Maven Central explicitly to work around:
20-
# https://github.com/dependabot/dependabot-core/issues/8329
19+
# Fix the Maven Central to the ASF repository to work around: https://github.com/dependabot/dependabot-core/issues/8329
2120
registries:
2221
maven-central:
2322
type: maven-repository
@@ -44,3 +43,8 @@ updates:
4443
directory: "/"
4544
schedule:
4645
interval: weekly
46+
47+
- package-ecosystem: npm
48+
directory: "/"
49+
schedule:
50+
interval: daily

‎.github/generate-email.sh

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ PROJECT_VERSION="$2"
4545
COMMIT_ID="$3"
4646

4747
# Check release notes file
48-
RELEASE_NOTES_FILE="$SCRIPT_DIR/../src/site/_release-notes/_$PROJECT_VERSION.adoc"
48+
RELEASE_NOTES_FILE="$SCRIPT_DIR/../target/generated-site/antora/modules/ROOT/pages/_release-notes/$PROJECT_VERSION.adoc"
4949
[ -f "$RELEASE_NOTES_FILE" ] || {
5050
stderr "Couldn't find release notes file: $RELEASE_NOTES_FILE"
5151
exit 1
@@ -69,15 +69,15 @@ case $1 in
6969
vote)
7070
cat <<EOF
7171
To: dev@logging.apache.org
72-
Title: [VOTE] Release $PROJECT_NAME $PROJECT_VERSION
72+
Title: [VOTE] Release $PROJECT_NAME \`$PROJECT_VERSION\`
7373
74-
This is a vote to release the $PROJECT_NAME $PROJECT_VERSION.
74+
This is a vote to release the $PROJECT_NAME \`$PROJECT_VERSION\`.
7575
76-
Website: $PROJECT_STAGING_SITE
76+
Website: $PROJECT_STAGING_SITE-$PROJECT_VERSION
7777
GitHub: $PROJECT_REPO
7878
Commit: $COMMIT_ID
7979
Distribution: $PROJECT_DIST_DIR
80-
Nexus: https://repository.apache.org/content/repositories/orgapachelogging-1113
80+
Nexus: https://repository.apache.org/content/repositories/orgapachelogging-<FIXME>
8181
Signing key: 0x077e8893a6dcc33dd4a4d5b256e73ba9a0b592d0
8282
8383
Please download, test, and cast your votes on this mailing list.
@@ -91,33 +91,31 @@ everyone to test the release, but only the Logging Services PMC
9191
votes are officially counted. At least 3 +1 votes and more
9292
positive than negative votes are required.
9393
94-
=== Review kit
94+
== Review kit
9595
9696
The minimum set of steps needed to review the uploaded distribution
9797
files in the Subversion repository can be summarized as follows:
9898
9999
$(dump_review_kit)
100100
101-
=== Release notes
102-
103-
$(dump_release_notes)
101+
== Release Notes
104102
EOF
103+
dump_release_notes
105104
;;
106105

107106
announce)
108107
cat <<EOF
109108
To: log4j-user@logging.apache.org, dev@logging.apache.org
110-
Title: [ANNOUNCE] $PROJECT_NAME $PROJECT_VERSION released
109+
Title: [ANNOUNCE] $PROJECT_NAME \`$PROJECT_VERSION\` released
111110
112-
${PROJECT_NAME} team is pleased to announce the $PROJECT_VERSION
113-
release. This project provides various Jakarta[1]-specific Apache
111+
${PROJECT_NAME} team is pleased to announce the \`$PROJECT_VERSION\`
112+
release. This project provides various Jakarta-specific Apache
114113
Log4j components. For further information (support, download,
115-
etc.) see the project website[2].
114+
etc.) see the project website[1].
116115
117-
[1] https://jakarta.ee
118-
[2] $PROJECT_SITE
116+
[1] $PROJECT_SITE
119117
120-
=== Release Notes
118+
== Release Notes
121119
EOF
122120
dump_release_notes
123121
;;

‎.github/workflows/build.yaml

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,33 +38,32 @@ jobs:
3838

3939
build:
4040
if: github.actor != 'dependabot[bot]'
41-
uses: apache/logging-parent/.github/workflows/build-reusable.yaml@rel/10.6.0
41+
uses: apache/logging-parent/.github/workflows/build-reusable.yaml@rel/11.0.0
4242
with:
4343
site-enabled: true
4444

4545
deploy-snapshot:
4646
needs: build
4747
if: github.repository == 'apache/logging-log4j-jakarta' && github.ref_name == 'main'
48-
uses: apache/logging-parent/.github/workflows/deploy-snapshot-reusable.yaml@rel/10.6.0
48+
uses: apache/logging-parent/.github/workflows/deploy-snapshot-reusable.yaml@rel/11.0.0
4949
# Secrets for deployments
5050
secrets:
51-
NEXUS_USER: ${{ secrets.NEXUS_USER }}
52-
NEXUS_PW: ${{ secrets.NEXUS_PW }}
51+
NEXUS_USERNAME: ${{ secrets.NEXUS_USER }}
52+
NEXUS_PASSWORD: ${{ secrets.NEXUS_PW }}
5353

5454
deploy-release:
5555
needs: build
5656
if: github.repository == 'apache/logging-log4j-jakarta' && startsWith(github.ref_name, 'release/')
57-
uses: apache/logging-parent/.github/workflows/deploy-release-reusable.yaml@rel/10.6.0
57+
uses: apache/logging-parent/.github/workflows/deploy-release-reusable.yaml@rel/11.0.0
5858
# Secrets for deployments
5959
secrets:
6060
GPG_SECRET_KEY: ${{ secrets.LOGGING_GPG_SECRET_KEY }}
61-
LOGGING_STAGE_DEPLOYER_USER: ${{ secrets.LOGGING_STAGE_DEPLOYER_USER }}
62-
LOGGING_STAGE_DEPLOYER_PW: ${{ secrets.LOGGING_STAGE_DEPLOYER_PW }}
61+
NEXUS_USERNAME: ${{ secrets.LOGGING_STAGE_DEPLOYER_USER }}
62+
NEXUS_PASSWORD: ${{ secrets.LOGGING_STAGE_DEPLOYER_PW }}
6363
SVN_USERNAME: ${{ secrets.LOGGING_SVN_DEV_USERNAME }}
6464
SVN_PASSWORD: ${{ secrets.LOGGING_SVN_DEV_PASSWORD }}
6565
# Write permissions to allow the Maven `revision` property update, changelog release, etc.
6666
permissions:
6767
contents: write
6868
with:
6969
project-id: log4j-jakarta
70-
site-enabled: true

‎.github/workflows/codeql-analysis.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ permissions: read-all
3131
jobs:
3232

3333
analyze:
34-
uses: apache/logging-parent/.github/workflows/codeql-analysis-reusable.yaml@rel/10.6.0
34+
uses: apache/logging-parent/.github/workflows/codeql-analysis-reusable.yaml@rel/11.0.0
3535
# Permissions required to publish Security Alerts
3636
permissions:
3737
actions: read

‎.github/workflows/deploy-site.yaml

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
#
2+
# Licensed to the Apache Software Foundation (ASF) under one or more
3+
# contributor license agreements. See the NOTICE file distributed with
4+
# this work for additional information regarding copyright ownership.
5+
# The ASF licenses this file to you under the Apache License, Version 2.0
6+
# (the "License"); you may not use this file except in compliance with
7+
# the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing, software
12+
# distributed under the License is distributed on an "AS IS" BASIS,
13+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
# See the License for the specific language governing permissions and
15+
# limitations under the License.
16+
#
17+
18+
name: deploy-site
19+
20+
on:
21+
push:
22+
branches:
23+
- "main"
24+
- "main-site-pro"
25+
- "release/*"
26+
paths-ignore:
27+
- "**.md"
28+
- "**.txt"
29+
30+
permissions: read-all
31+
32+
jobs:
33+
34+
deploy-site-stg:
35+
if: github.repository == 'apache/logging-log4j-jakarta' && github.ref_name == 'main'
36+
uses: apache/logging-parent/.github/workflows/deploy-site-reusable.yaml@rel/11.0.0
37+
# Secrets for committing the generated site
38+
secrets:
39+
GPG_SECRET_KEY: ${{ secrets.LOGGING_GPG_SECRET_KEY }}
40+
# Write permissions for committing the generated site
41+
permissions:
42+
contents: write
43+
with:
44+
asf-yaml-content: |
45+
staging:
46+
profile: ~
47+
whoami: ${{ github.ref_name }}-site-stg-out
48+
subdir: content/log4j/jakarta
49+
target-branch: ${{ github.ref_name }}-site-stg-out
50+
51+
deploy-site-pro:
52+
if: github.repository == 'apache/logging-log4j-jakarta' && github.ref_name == 'main-site-pro'
53+
uses: apache/logging-parent/.github/workflows/deploy-site-reusable.yaml@rel/11.0.0
54+
# Secrets for committing the generated site
55+
secrets:
56+
GPG_SECRET_KEY: ${{ secrets.LOGGING_GPG_SECRET_KEY }}
57+
# Write permissions for committing the generated site
58+
permissions:
59+
contents: write
60+
with:
61+
asf-yaml-content: |
62+
publish:
63+
profile: ~
64+
whoami: ${{ github.ref_name }}-out
65+
subdir: content/log4j/jakarta
66+
target-branch: ${{ github.ref_name }}-out
67+
68+
export-version:
69+
if: github.repository == 'apache/logging-log4j-jakarta' && startsWith(github.ref_name, 'release/')
70+
runs-on: ubuntu-latest
71+
outputs:
72+
version: ${{ steps.export-version.outputs.version }}
73+
steps:
74+
- name: Export version
75+
id: export-version
76+
run: |
77+
version=$(echo "${{ github.ref_name }}" | sed 's/^release\///')
78+
echo "version=$version" >> "$GITHUB_OUTPUT"
79+
80+
deploy-site-rel:
81+
needs: export-version
82+
uses: apache/logging-parent/.github/workflows/deploy-site-reusable.yaml@rel/11.0.0
83+
# Secrets for committing the generated site
84+
secrets:
85+
GPG_SECRET_KEY: ${{ secrets.LOGGING_GPG_SECRET_KEY }}
86+
# Write permissions for committing the generated site
87+
permissions:
88+
contents: write
89+
with:
90+
asf-yaml-content: |
91+
staging:
92+
profile: ~
93+
whoami: ${{ github.ref_name }}-site-stg-out
94+
subdir: content/log4j/jakarta-${{ needs.export-version.outputs.version }}
95+
target-branch: ${{ github.ref_name }}-site-stg-out

‎.github/workflows/merge-dependabot.yaml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,13 @@ jobs:
3030

3131
build:
3232
if: github.repository == 'apache/logging-log4j-jakarta' && github.event_name == 'pull_request_target' && github.actor == 'dependabot[bot]'
33-
uses: apache/logging-parent/.github/workflows/build-reusable.yaml@rel/10.6.0
33+
uses: apache/logging-parent/.github/workflows/build-reusable.yaml@rel/11.0.0
34+
with:
35+
site-enabled: true
3436

3537
merge-dependabot:
3638
needs: build
37-
uses: apache/logging-parent/.github/workflows/merge-dependabot-reusable.yaml@rel/10.6.0
39+
uses: apache/logging-parent/.github/workflows/merge-dependabot-reusable.yaml@rel/11.0.0
3840
permissions:
3941
contents: write # to push changelog commits
4042
pull-requests: write # to close the PR

‎.github/workflows/scorecards-analysis.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ permissions: read-all
2929
jobs:
3030

3131
analysis:
32-
uses: apache/logging-parent/.github/workflows/scorecards-analysis-reusable.yaml@rel/10.6.0
32+
uses: apache/logging-parent/.github/workflows/scorecards-analysis-reusable.yaml@rel/11.0.0
3333
permissions:
3434
# Needed to upload the results to the code-scanning dashboard.
3535
security-events: write

‎.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,7 @@ target/
2424
.project
2525
.classpath
2626
.settings/
27+
# Node
28+
node
29+
node_modules
30+
package-lock.json

0 commit comments

Comments
 (0)