Skip to content

Commit

Permalink
Sync ci/cd and migration scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
adikhoff committed Oct 11, 2024
1 parent 5e5f9e9 commit 3190036
Show file tree
Hide file tree
Showing 10 changed files with 389 additions and 25 deletions.
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ labels: bug
assignees: ''
---

**Your Godot version:**
**Your Redot version:**

**Issue description:**

**URL to the documentation page:**

If you know how to fix the issue you are reporting please
consider opening a pull request. We provide a tutorial on
using git here: https://docs.godotengine.org/en/stable/community/contributing/pr_workflow.html,
writing documentation at https://docs.godotengine.org/en/stable/community/contributing/docs_writing_guidelines.html
and contributing to the class reference here: https://docs.godotengine.org/en/stable/community/contributing/updating_the_class_reference.html
using git here: https://docs.redotengine.org/en/stable/community/contributing/pr_workflow.html,
writing documentation at https://docs.redotengine.org/en/stable/community/contributing/docs_writing_guidelines.html
and contributing to the class reference here: https://docs.redotengine.org/en/stable/community/contributing/updating_the_class_reference.html
14 changes: 9 additions & 5 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
blank_issues_enabled: false

contact_links:
- name: Godot community channels
url: https://godotengine.org/community
- name: Redot community channels
url: https://redotengine.org/community
about: Please ask for technical support on one of the other community channels, not here.

- name: Main Godot repository
url: https://github.com/godotengine/godot
about: Report engine bugs on the main Godot repository
- name: Redot proposals
url: https://github.com/redot-engine/redot-proposals
about: Please submit engine feature proposals on the Redot proposals repository, not here.

- name: Main Redot repository
url: https://github.com/redot-engine/redot
about: Report engine bugs on the main Redot repository
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/enhancement_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ labels: enhancement
assignees: ''
---

**Your Godot version:**
**Your Redot version:**

**Issue description:**

Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ PRs can target other branches (e.g. `3.2`, `3.5`) if the same change was done in
PRs must not target `stable`, as that branch is updated manually.
The type of content accepted into the documentation is explained here:
https://docs.godotengine.org/en/latest/community/contributing/content_guidelines.html
https://docs.redotengine.org/en/latest/community/contributing/content_guidelines.html
-->
18 changes: 11 additions & 7 deletions .github/workflows/build_offline_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,16 @@ jobs:
sudo apt update
sudo apt install parallel libwebp7
- name: Migrate to Redot
run: |
python migrate.py . _migrated False
- name: Sphinx - Build HTML
run: make SPHINXOPTS='--color' html
run: make SPHINXOPTS='--color' SPHINXSOURCEDIR='./_migrated' html

- uses: actions/upload-artifact@v4
with:
name: godot-docs-html-${{ matrix.branch }}
name: redot-docs-html-${{ matrix.branch }}
path: _build/html
# Keep the current build and the previous build (in case a scheduled build failed).
# This makes it more likely to have at least one successful build available at all times.
Expand All @@ -46,15 +50,15 @@ jobs:
parallel --will-cite sed -i "s/\\.webp$/\\.png/g" ::: {about,community,contributing,getting_started,tutorials}/**/*.rst
# Remove banners at the top of each page when building `latest`.
sed -i 's/"godot_is_latest": True/"godot_is_latest": False/' conf.py
sed -i 's/"godot_show_article_status": True/"godot_show_article_status": False/' conf.py
sed -i 's/"redot_is_latest": True/"redot_is_latest": False/' conf.py
sed -i 's/"redot_show_article_status": True/"redot_show_article_status": False/' conf.py
make SPHINXOPTS='--color' epub
make SPHINXOPTS='--color' SPHINXSOURCEDIR='./_migrated' epub
- uses: actions/upload-artifact@v4
with:
name: godot-docs-epub-${{ matrix.branch }}
path: _build/epub/GodotEngine.epub
name: redot-docs-epub-${{ matrix.branch }}
path: _build/epub/RedotEngine.epub
# Keep the current build and the previous build (in case a scheduled build failed).
# This makes it more likely to have at least one successful build available at all times.
retention-days: 15
6 changes: 5 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ jobs:
bash _tools/format.sh
codespell -I _tools/codespell-ignore.txt -x _tools/codespell-ignore-lines.txt -S tutorials/i18n/locales.rst {about,community,contributing,getting_started,tutorials}/**/*.rst
- name: Migrate to Redot
run: |
python migrate.py . _migrated True
# Use dummy builder to improve performance as we don't need the generated HTML in this workflow.
- name: Sphinx build
run: make SPHINXOPTS='--color -W' dummy
run: make SPHINXOPTS='--color -W' SPHINXSOURCEDIR='./_migrated' dummy
10 changes: 5 additions & 5 deletions .github/workflows/sync_class_ref.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
- name: Checkout the engine repository
uses: actions/checkout@v4
with:
repository: 'godotengine/godot'
repository: 'redot-engine/redot-engine'
# Use the appropriate branch for the documentation version.
ref: ${{ env.engine_rev }}
path: './.engine-src'
Expand All @@ -33,7 +33,7 @@ jobs:
cd ./.engine-src
hash=$(git rev-parse HEAD)
hash_short=$(git rev-parse --short HEAD)
echo "Checked out godotengine/godot at $hash"
echo "Checked out redot-engine/redot at $hash"
echo "rev_hash=$hash" >> $GITHUB_OUTPUT
echo "rev_hash_short=$hash_short" >> $GITHUB_OUTPUT
Expand All @@ -54,10 +54,10 @@ jobs:
delete-branch: true

# Configure the commit author.
author: 'Godot Organization <noreply@godotengine.org>'
committer: 'Godot Organization <noreply@godotengine.org>'
author: 'Redot Organization <noreply@redot-url.org>'
committer: 'Redot Organization <noreply@redot-url.org>'

# Configure the pull-request.
title: 'classref: Sync with current ${{ env.engine_rev }} branch (${{ steps.engine.outputs.rev_hash_short }})'
body: 'Update Godot API online class reference to match the engine at https://github.com/godotengine/godot/commit/${{ steps.engine.outputs.rev_hash }} (`${{ env.engine_rev }}`).'
body: 'Update Redot API online class reference to match the engine at https://github.com/redot-engine/redot/commit/${{ steps.engine.outputs.rev_hash }} (`${{ env.engine_rev }}`).'
labels: 'area:class reference,bug,enhancement'
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
.env

_build/
_build-old/
_migrated/
env/
__pycache__
*.pyc
Expand Down
36 changes: 35 additions & 1 deletion img/docs_logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 3190036

Please sign in to comment.