-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Fixes #5500 - Add a Github Actions workflow that builds the docs #5631
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
e1c2a2d
Fixes #5500 - Add a Github Actions workflow that builds the docs
martin-g c66dc19
Test: edit an .md file
martin-g 3a26c94
Copy the generated HTMLs in asf-site branch
martin-g 6576626
Publish built docs triggered by 3a26c940904f74fb9c94c933363281e44930c475
github-actions[bot] 8ac8a60
Copy the generated HTMLs in asf-site branch
martin-g File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -39,3 +39,7 @@ github: | |
| rebase: false | ||
| features: | ||
| issues: true | ||
|
|
||
| publish: | ||
| whoami: asf-site | ||
| subdir: datafusion | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| on: | ||
| push: | ||
| branches: | ||
| - master | ||
| - issue-5500-asf.yaml-docs | ||
| paths: | ||
| - .github/workflows/docs.yaml | ||
| - docs/** | ||
|
|
||
| name: Deploy DataFusion site | ||
|
|
||
| jobs: | ||
| build-docs: | ||
| name: Build docs | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout docs sources | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: Checkout asf-site branch | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| ref: asf-site | ||
| path: asf-site | ||
|
|
||
| - name: Setup Python | ||
| uses: actions/setup-python@v4 | ||
| with: | ||
| python-version: "3.10" | ||
|
|
||
| - name: Install dependencies | ||
| run: | | ||
| set -x | ||
| python3 -m venv venv | ||
| source venv/bin/activate | ||
| pip install -r docs/requirements.txt | ||
|
|
||
| - name: Build docs | ||
| run: | | ||
| set -x | ||
| source venv/bin/activate | ||
| cd docs | ||
| ./build.sh | ||
|
|
||
| - name: Copy & push the generated HTML | ||
| run: | | ||
| set -x | ||
| cd asf-site/ | ||
| # delete anything but: 1) '.'; 2) '..'; 3) .git/ | ||
| find ./ | grep -vE "^./$|^../$|^./.git" | xargs rm -rf | ||
| cp ../.asf.yaml . | ||
| cp -rT ../docs/build/html/ . | ||
| git status --porcelain | ||
| if [ "$(git status --porcelain)" != "" ]; then | ||
| git config user.name "github-actions[bot]" | ||
| git config user.email "github-actions[bot]@users.noreply.github.com" | ||
| git add --all | ||
| git commit -m 'Publish built docs triggered by ${{ github.sha }}' | ||
| git push || git push --force | ||
| fi |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Converted the PR to a Draft one because of this change.
See #5500 (comment)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@andygrove or @houqp do you remember what this is used for or if it is critical to fix?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(I personally think that as long as this removal doesn't render the docs inoperable, it would be fine to remove this code to get the docs publishing and fix it afterwards)