Skip to content

chore: Publish docs#166

Merged
raulcd merged 3 commits into
apache:mainfrom
kou:docs
Jun 19, 2025
Merged

chore: Publish docs#166
raulcd merged 3 commits into
apache:mainfrom
kou:docs

Conversation

@kou

@kou kou commented Jun 18, 2025

Copy link
Copy Markdown
Member

What's Changed

Build docs by CI and:

Push an RC tag:

  • Upload the built docs to GitHub Releases

Push a release tag:

  • Publish the uploaded docs to https://arrow.apache.org/js/{current,${VERSION}} via the asf-site branch

Push to main in apache/arrow-js:

Push to non main in apache/arrow-js:

  • Do nothing

Push to foks:

Closes #10.

@kou kou requested review from assignUser and raulcd June 18, 2025 08:35
@kou

kou commented Jun 18, 2025

Copy link
Copy Markdown
Member Author

RC example: https://github.com/kou/arrow-js/releases/tag/v20.0.0-rc3
Release example: https://github.com/kou/arrow-js/releases/tag/v20.0.0
asf-site example: https://github.com/kou/arrow-js/tree/asf-site

@kou kou mentioned this pull request Jun 19, 2025
Closed
raulcd
raulcd reviewed Jun 19, 2025
View reviewed changes

@raulcd raulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kou are those scripts and workflows based on any other of our repos or is this process completely different? I am currently losing track on how we do things on others. I tried to understand what was going on with the different branches / directories / forks and really got it when I read the description of the PR. It seems quite important to understand the process, should we add something similar to the PR description to the documentation?

In general looks good to me, I am just slightly concerned whether we will be able to remember what was going on with the different branches/folders/workflows once we have to update it in the future.

@kou

kou commented Jun 19, 2025

Copy link
Copy Markdown
Member Author

are those scripts and workflows based on any other of our repos or is this process completely different?

These implementations are completely different from others.
Documentation URL style (`/js/{main,current,${version}/') is same as ADBC's one.

apache/arrow-adbc and apache/arrow-nanoarrow are only automate documentation publishing.
(apache/arrow also automates dev documentation publishing but apache/arrow uses separated apache/arrow-site repo. So it's not done in each commit of main in apache/arrow.)

apache/arrow-adbc nor apache/arrow-nanoarrow don't support preview by GitHub Pages on fork. So apache/arrow-js implementation is (a bit?) more complex than them.

I am currently losing track on how we do things on others. I tried to understand what was going on with the different branches / directories / forks and really got it when I read the description of the PR. It seems quite important to understand the process, should we add something similar to the PR description to the documentation?

Good point. I'll add dev/release/docs.md. I don't want to add it to dev/release/README.md. I want to keep dev/release/README.md just about our release process.

@raulcd

raulcd commented Jun 19, 2025

Copy link
Copy Markdown
Member

Good point. I'll add dev/release/docs.md. I don't want to add it to dev/release/README.md. I want to keep dev/release/README.md just about our release process.

Thanks, I think this will be helpful in the future.

@kou

kou commented Jun 19, 2025

Copy link
Copy Markdown
Member Author

How about this?
https://github.com/kou/arrow-js/blob/docs/dev/release/docs.md

raulcd
raulcd approved these changes Jun 19, 2025
View reviewed changes

@raulcd raulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM just a couple of nits

Comment thread dev/release/docs.md Outdated
Comment thread dev/release/docs.md Outdated
kou and others added 2 commits June 19, 2025 18:53
@raulcd raulcd merged commit 2e0ef8b into apache:main Jun 19, 2025
15 of 16 checks passed
@raulcd

raulcd commented Jun 19, 2025

Copy link
Copy Markdown
Member

asf-site has been correctly generated:
fb0a5b3

@kou kou deleted the docs branch June 19, 2025 21:27
@kou

kou commented Jun 19, 2025

Copy link
Copy Markdown
Member Author

Deployed: https://arrow.apache.org/js/main/

@kou kou mentioned this pull request Aug 26, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@raulcd raulcd raulcd approved these changes
@assignUser assignUser Awaiting requested review from assignUser

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Publish https://arrow.apache.org/js/

2 participants

@kou @raulcd