Skip to content

Add workflow for importing documentation from everest-doc by version #5

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.

Sign up for GitHub

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

Draft
solovevayaroslavna wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add workflow for importing documentation from everest-doc by version #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bbc2e8f
feature/documentation-exporting: add workflow for importing documenta…
solovevayaroslavna Dec 11, 2025
21ccffc
feature/documentation-exporting: fix: ensure correct test branch refe…
solovevayaroslavna Dec 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/workflows/tag-release.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Import Documentation

on:
workflow_dispatch:
inputs:
version:
description: 'Version number to import (e.g., 1.15)'
required: true
type: string

jobs:
import-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
ref: feature/documentation-exporting

- name: Set up Docker
uses: docker/setup-buildx-action@v2

- name: Run import script
run: |
bash hack/import_docs.sh ${{ inputs.version }}
Copy link
Copy Markdown
Contributor

@chilagrow chilagrow Dec 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I'm not sure if it's a good idea to add automated workflow on top of a hack. Just a question, why is importing document a hack? 🤔

Also I often make sure that what goes into main branch is reviewed by some human 🤔. What do you think?

Copy link
Copy Markdown
Contributor Author

@solovevayaroslavna solovevayaroslavna Dec 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

We can change the script so that it immediately prepares the PR with the changes, so that only a couple of buttons remain to be pressed, what do you think about this?

To be honest hack - it's just a name. It's not something illegal or forbidden.

I just don't think it's common practice to import static files from another repository
Maybe we'll find a more beautiful way later... like... to have a subrepo of documentation and catch the build another way.

Copy link
Copy Markdown
Contributor

@chilagrow chilagrow Dec 12, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for the explanation! I understand your concern about importing static files from another repo is not standard 😄. What is standard for using content from another repository is git submodule, which is as you say, subrepo. Let's keep it as an option for future.

I like the idea about preparing PR! Then we can see it with our eyes before we merge 🤗

Copy link
Copy Markdown
Contributor

@spron-in spron-in Dec 16, 2025

Choose a reason for hiding this comment

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

So what do we do here? :)

Copy link
Copy Markdown
Contributor Author

@solovevayaroslavna solovevayaroslavna Dec 16, 2025

Choose a reason for hiding this comment

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

@spron-in I will correct the script so that it creates a new PR in this repository if a new tag with a new version of release-notes appears in the everest-doc (but a little later, closer to the moment when we want to release a new tag for open-everest)


- name: Commit and push changes
run: |
git config --local user.email "action@github.com"
git config --local user.name "GitHub Action"
git add assets/documentation/${{ inputs.version }}
git diff-index --quiet HEAD || git commit -m "docs: import documentation for version ${{ inputs.version }}"
# git push origin $(git rev-parse --abbrev-ref HEAD)
git push origin feature/documentation-exporting