Skip to content

Commit

Permalink
Update deploy script and add 1.4.3 updates (apache#9519)
Browse files Browse the repository at this point in the history
  • Loading branch information
bitsondatadev authored and devangjhabakh committed Apr 22, 2024
1 parent 99061a3 commit aafd826
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 2 deletions.
4 changes: 4 additions & 0 deletions site/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,10 @@ make build OFFLINE=true
## Release process

Deploying the docs is a two step process:

> [!WARNING]
> 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.
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.
```
make release ICEBERG_VERSION=${ICEBERG_VERSION}
Expand Down
2 changes: 1 addition & 1 deletion site/dev/deploy.sh
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ set -e

./dev/setup_env.sh

mkdocs gh-deploy --dirty # --remote-branch asf-site
mkdocs gh-deploy --remote-name "${REMOTE}" # --remote-branch asf-site

2 changes: 1 addition & 1 deletion site/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ markdown_extensions:
permalink: 🔗

extra:
icebergVersion: '1.4.2'
icebergVersion: '1.4.3'
social:
- icon: fontawesome/regular/comments
link: 'https://iceberg.apache.org/community/'
Expand Down
1 change: 1 addition & 0 deletions site/nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ nav:
- Hive: hive-quickstart.md
- Docs:
- latest: '!include docs/docs/latest/mkdocs.yml'
- 1.4.3: '!include docs/docs/1.4.3/mkdocs.yml'
- 1.4.2: '!include docs/docs/1.4.2/mkdocs.yml'
- 1.4.1: '!include docs/docs/1.4.1/mkdocs.yml'
- 1.4.0: '!include docs/docs/1.4.0/mkdocs.yml'
Expand Down

0 comments on commit aafd826

Please sign in to comment.