Skip to content

Commit d011cb7

Browse files
pingtimeoutsnazy
pingtimeout
and
snazy
authored
Rework release guide to include workflows (#3273)
* Add a release guides section * Rename current release guide to manual (deprecated) * Add new semi-automated release guide * Move release verification guide under release guides section * Add scss style for better screenshot separation * Add redirection from old pages to new ones Co-authored-by: Robert Stupp <[email protected]>
1 parent c6ee521 commit d011cb7

File tree

15 files changed

+458
-99
lines changed

15 files changed

+458
-99
lines changed

‎site/assets/scss/_styles_project.scss‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,11 @@
3535
width: 100%;
3636
}
3737
}
38+
39+
// Screenshot styling for better visual separation
40+
img[alt*="Screenshot"] {
41+
border: 1px solid #dee2e6;
42+
border-radius: 4px;
43+
box-shadow: 0 8px 24px rgba(0, 0, 0, 0.3) !important;
44+
margin: 1rem 0;
45+
}

‎site/content/community/release-guide.md‎

Lines changed: 0 additions & 25 deletions
This file was deleted.

‎site/content/community/release-guides/_index.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
#
3+
# Licensed to the Apache Software Foundation (ASF) under one
4+
# or more contributor license agreements. See the NOTICE file
5+
# distributed with this work for additional information
6+
# regarding copyright ownership. The ASF licenses this file
7+
# to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance
9+
# with the License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing,
14+
# software distributed under the License is distributed on an
15+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
# KIND, either express or implied. See the License for the
17+
# specific language governing permissions and limitations
18+
# under the License.
19+
#
20+
linkTitle: Release Guides
21+
title: Apache Polaris Release Guides
22+
type: docs
23+
weight: 500
24+
cascade:
25+
type: docs
26+
---
27+
28+
This section contains documentation related to Apache Polaris releases.
29+
30+
If you're new to releasing Apache Polaris, we recommend reading the manual release guide first to understand the process. Do not perform any actions described in the manual guide, as the semi-automated guide will handle them for you. Simply read through the manual guide to understand the process.
31+
32+
Once you are familiar with the manual release process, use the semi-automated guide to cut the release.
33+
34+
If you want to verify a release, head to the release verification guide.
35+
36+
## Available Release Guides
37+
38+
### Semi-Automated Release Guide
39+
The [semi-automated release guide](semi-automated-release-guide/) describes how GitHub workflows are used to perform a release with little manual intervention. This guide automates many of the manual steps while maintaining the necessary oversight and validation required for Apache releases. It is the preferred approach for cutting Apache Polaris releases.
40+
41+
### Manual Release Guide (deprecated)
42+
The [manual release guide](manual-release-guide/) walks through each step of creating an Apache Polaris release. This guide provides detailed instructions for every aspect of the release process but requires significant manual intervention. It is deprecated in favor of the semi-automated approach above, but is maintained for reference and fallback scenarios.
43+
44+
### Release Verification Guide
45+
The [release verification guide](release-verification-guide/) provides instructions for verifying an Apache Polaris release, like verifying checksums and signatures, ensuring release artifacts integrity, ...

site/content/release-guide.md renamed to site/content/community/release-guides/manual-release-guide.md

Lines changed: 33 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,40 @@
1-
<!--
2-
Licensed to the Apache Software Foundation (ASF) under one
3-
or more contributor license agreements. See the NOTICE file
4-
distributed with this work for additional information
5-
regarding copyright ownership. The ASF licenses this file
6-
to you under the Apache License, Version 2.0 (the
7-
"License"); you may not use this file except in compliance
8-
with the License. You may obtain a copy of the License at
9-
10-
http://www.apache.org/licenses/LICENSE-2.0
11-
12-
Unless required by applicable law or agreed to in writing,
13-
software distributed under the License is distributed on an
14-
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15-
KIND, either express or implied. See the License for the
16-
specific language governing permissions and limitations
17-
under the License.
18-
-->
19-
20-
# Release Manager Guide
1+
---
2+
#
3+
# Licensed to the Apache Software Foundation (ASF) under one
4+
# or more contributor license agreements. See the NOTICE file
5+
# distributed with this work for additional information
6+
# regarding copyright ownership. The ASF licenses this file
7+
# to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance
9+
# with the License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing,
14+
# software distributed under the License is distributed on an
15+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
# KIND, either express or implied. See the License for the
17+
# specific language governing permissions and limitations
18+
# under the License.
19+
#
20+
linkTitle: Manual Release Guide (deprecated)
21+
title: Manual Release Guide (deprecated)
22+
type: docs
23+
weight: 200
24+
aliases:
25+
- /release-guide
26+
- /community/release-guide
27+
---
2128

2229
**Audience**: Release Managers
2330

31+
{{< alert warning >}}
32+
**This guide is deprecated.** While it remains functional and comprehensive, we recommend using the Semi-Automated Release Guide for new releases when available. This manual process is maintained for reference and fallback scenarios.
33+
{{< /alert >}}
34+
2435
This guide walks you through the process of **creating** a release of the Apache Polaris podling.
2536

26-
Instructions how to verify a release candidate are available [here](release-verify.md).
37+
Instructions how to verify a release candidate are available [here](../release-verification-guide/).
2738

2839
## Setup
2940

@@ -93,7 +104,7 @@ For more information, see the Gradle [signing documentation](https://docs.gradle
93104

94105
### Helm chart signing
95106

96-
Helm chart artifacts are signed with your key, using the [helm gpg plugin](https://github.com/technosophos/helm-gpg). Ensure the plugin is installed locally.
107+
Helm chart artifacts are signed with your key, using the [helm gpg plugin](https://github.com/technosophos/helm-gpg). Ensure the plugin is installed locally.
97108

98109
### GitHub Repository
99110

site/content/release-verify.md renamed to site/content/community/release-guides/release-verification-guide.md

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,30 @@
1-
<!--
2-
Licensed to the Apache Software Foundation (ASF) under one
3-
or more contributor license agreements. See the NOTICE file
4-
distributed with this work for additional information
5-
regarding copyright ownership. The ASF licenses this file
6-
to you under the Apache License, Version 2.0 (the
7-
"License"); you may not use this file except in compliance
8-
with the License. You may obtain a copy of the License at
9-
10-
http://www.apache.org/licenses/LICENSE-2.0
11-
12-
Unless required by applicable law or agreed to in writing,
13-
software distributed under the License is distributed on an
14-
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15-
KIND, either express or implied. See the License for the
16-
specific language governing permissions and limitations
17-
under the License.
18-
-->
19-
20-
# Release Verification Guide
1+
---
2+
#
3+
# Licensed to the Apache Software Foundation (ASF) under one
4+
# or more contributor license agreements. See the NOTICE file
5+
# distributed with this work for additional information
6+
# regarding copyright ownership. The ASF licenses this file
7+
# to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance
9+
# with the License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing,
14+
# software distributed under the License is distributed on an
15+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
# KIND, either express or implied. See the License for the
17+
# specific language governing permissions and limitations
18+
# under the License.
19+
#
20+
linkTitle: Release Verification Guide
21+
title: Release Verification Guide
22+
type: docs
23+
weight: 300
24+
aliases:
25+
- /release-verify
26+
- /community/release-verify
27+
---
2128

2229
**Audience**: Committers and interested contributors.
2330

0 commit comments

Comments
 (0)