Skip to content

Commit

Permalink
Prepare to release 11.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
vy committed Apr 15, 2024
1 parent 05d5ef6 commit ce75abf
Show file tree
Hide file tree
Showing 17 changed files with 87 additions and 2 deletions.
4 changes: 2 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@
<properties>

<!-- project version -->
<revision>11.0.0-SNAPSHOT</revision>
<revision>11.0.0</revision>

<!-- `project.build.outputTimestamp` is required to be present for reproducible builds.
We actually inherit one from the `org.apache:apache` parent.
Expand Down Expand Up @@ -247,7 +247,7 @@
<!-- site-specific versions -->
<!-- We use a separate property than `project.version` to refer to the most recent _published_ version of the project.
This will be used in the site and updated automatically by `dependabot`. -->
<site-project.version>10.6.0</site-project.version>
<site-project.version>11.0.0</site-project.version>

</properties>

Expand Down
64 changes: 64 additions & 0 deletions src/changelog/11.0.0/.release-notes.adoc.ftl
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
////
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
////

////
██ ██ █████ ██████ ███ ██ ██ ███ ██ ██████ ██
██ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██ ██ ██
██ █ ██ ███████ ██████ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██
██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██

IF THIS FILE DOESN'T HAVE A `.ftl` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT!

Version-specific release notes (`7.8.0.adoc`, etc.) are generated from `src/changelog/*/.release-notes.adoc.ftl`.
Auto-generation happens during `generate-sources` phase of Maven.
Hence, you must always

1. Find and edit the associated `.release-notes.adoc.ftl`
2. Run `./mvnw generate-sources`
3. Commit both `.release-notes.adoc.ftl` and the generated `7.8.0.adoc`
////

[#release-notes-${release.version?replace("[^a-zA-Z0-9]", "-", "r")}]
== ${release.version}

<#if release.date?has_content>Release date:: ${release.date}</#if>

This release contains a big revamp to the website build and several other minor enhancements.

[#release-notes-11-0-0-website-build]
=== Website build changes

The website build system is migrated from `asciidoctor-maven-plugin` to Antora.
This implies that `src/site` and `generate-email.sh` files need to be adapted, and `target/site` can be viewed without needing a local web server.

The Maven `site` phase is re-engineered such that _generated sources_ (i.e., `src/site/_release_notes` and `src/site/_constants.adoc`) will be targeted to `target/generated-site` and the website will be built from there.
This avoids the need to commit generated sources to the repository and, hence, works around changelog merge conflict problems.

[#release-notes-11-0-0-website-deployment]
=== Website deployment changes

The newly added `site-deploy-reusable.yaml` GitHub Actions workflow enables to automate the website deployment.
Using the `<source-branch>-site-<environment>-out` branch naming convention, the Maven `site` goal running on

* the `main` branch populates the `main-site-stg-out` branch serving the `logging.staged.apache.org/logging-parent`
* the `main-site-pro` branch populates the `main-site-pro-out` branch serving the `logging.apache.org/logging-parent`
* the `release/<version>` branch populates the `release/<version>-site-stg-out` branch serving the `logging.staged.apache.org/logging-parent-<version>`

Refer to the usage and project release instructions pages for details.

<#include "../.changelog.adoc.ftl">
21 changes: 21 additions & 0 deletions src/changelog/11.0.0/.release.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Licensed to the Apache Software Foundation (ASF) under one or more
~ contributor license agreements. See the NOTICE file distributed with
~ this work for additional information regarding copyright ownership.
~ The ASF licenses this file to you under the Apache License, Version 2.0
~ (the "License"); you may not use this file except in compliance with
~ the License. You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing, software
~ distributed under the License is distributed on an "AS IS" BASIS,
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
<release xmlns="https://logging.apache.org/xml/ns"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
date="2024-04-15" version="11.0.0"/>
File renamed without changes.
File renamed without changes.

0 comments on commit ce75abf

Please sign in to comment.