Skip to content

Commit 7bb0fa2

Browse files
stevenzwuclaudekevinjqliu
authored
Docs: Drop manual deploy step from release instructions (#16495)
* Docs: Drop manual deploy step from release instructions The site-ci GitHub Actions workflow runs make deploy automatically on any push to main that touches docs/, site/, or format/. Replace the manual "Release versioned docs and javadoc" step in the release guide with a note describing the auto-trigger so release managers don't push to asf-site by hand. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Co-authored-by: Kevin Liu <kevinjqliu@users.noreply.github.com> Co-authored-by: Kevin Liu <kevin.jq.liu@gmail.com>
1 parent 2cce97a commit 7bb0fa2

2 files changed

Lines changed: 9 additions & 20 deletions

File tree

site/README.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -174,22 +174,8 @@ make build OFFLINE=true
174174
175175
## Release process
176176

177-
Deploying the docs is a two-step process:
178-
179-
> [!WARNING]
180-
> The `make release` directive is currently unavailable as we wanted to discuss the best way forward on how or if we should automate the release. It involves taking an existing snapshot of the versioned documentation, and potentially automerging the [`docs` branch](https://github.com/apache/iceberg/tree/docs) and the [`javadoc` branch](https://github.com/apache/iceberg/tree/javadoc) which are independent from the `main` branch. Once this is complete, we can create a pull request with an offline build of the documentation to verify everything renders correctly, and then have the release manager merge that PR to finalize the docs release. So the real process would be manually invoking a docs release action, then merging a pull request.
181-
182-
1. Release a new version by copying the current `/docs` directory to a new version directory in the `docs` branch and a new javadoc build in the `javadoc` branch.
183-
```sh
184-
make release ICEBERG_VERSION=${ICEBERG_VERSION}
185-
```
186-
1. Build and push the generated site to the `asf-site` branch of [remote repo](https://github.com/apache/iceberg). This requires committer write permission.
187-
```sh
188-
# Default remote name is 'origin'
189-
make deploy
190-
# Or specify a different remote
191-
make deploy remote_name=apache
192-
```
177+
For release documentation publishing steps, follow the
178+
[Documentation Release](docs/how-to-release.md#documentation-release) section of the release guide.
193179

194180
## Validate Links
195181

site/docs/how-to-release.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -356,15 +356,18 @@ cp -R apache-iceberg-1.8.0/site/docs/javadoc/1.8.0 1.8.0
356356

357357
Once this is done, create a PR against the `javadoc` branch, similar to https://github.com/apache/iceberg/pull/12412.
358358

359-
#### Release versioned docs and javadoc
360-
361-
Please follow the instructions on the GitHub repository in the [`README.md` in the `site/`](https://github.com/apache/iceberg/tree/main/site) directory.
362-
363359
#### Site update
364360

365361
Submit a PR, following the approach in https://github.com/apache/iceberg/pull/12242,
366362
to update the Iceberg version, the links to the new version's documentation, and the release notes.
367363

364+
Once this PR is merged, the [`site-ci`](https://github.com/apache/iceberg/blob/main/.github/workflows/site-ci.yml)
365+
GitHub Actions workflow is automatically triggered for any push to `main` that touches `docs/`, `site/`,
366+
or `format/`. The workflow runs `make deploy` to build and push the documentation site to the `asf-site`
367+
branch, which publishes the new version's docs and javadoc.
368+
369+
The site will be updated automatically. Manually running `make deploy` is no longer required as part of the release.
370+
368371
# How to Verify a Release
369372

370373
Each Apache Iceberg release is validated by the community by holding a vote. A community release manager

0 commit comments

Comments
 (0)