Activity

1. AlexanderLanin

   added

   community:infrastructureGeneral Score infrastructure topicsGeneral Score infrastructure topics

   docs-as-code

   on Jan 21, 2025
2. AlexanderLanin

   added this to INF - Infrastructure Communityon Jan 21, 2025
3. AlexanderLanin

   moved this to Todo in INF - Infrastructure Communityon Jan 21, 2025
4. AlexanderLanin

   added

   good first issueGood for newcomersGood for newcomers

   automation

   on Jan 28, 2025
5. AlexanderLanin

   added a parent issue on Jan 29, 2025

   • docs: usability improvements #246
6. dcalavrezo-qorix

   self-assigned this

   on Jan 29, 2025
7. dcalavrezo-qorix

   moved this from Todo to In Progress in INF - Infrastructure Communityon Jan 29, 2025
8. dcalavrezo-qorix commented on Jan 29, 2025

   

   dcalavrezo-qorix

   on Jan 29, 2025

   Last edited by dcalavrezo-qorix

   Contributor

   More actions

   While pr-preview-action focuses on PR previews, our current action includes a versions file to track deployed versions.
   Since maintaining a list of all deployed versions is crucial (for traceability purposes and not only), we should implement an additional mechanism alongside pr-preview-action or we should make a comparison between deploy-version-pages and pr-preview-action and focus on improving our own action
9. dcalavrezo-qorix commented on Jan 29, 2025

   

   dcalavrezo-qorix

   on Jan 29, 2025

   Contributor

   More actions

   Focusing on the differences between the two actions and ways to improve our implementation for a consolidated result
10. AlexanderLanin commented on Jan 29, 2025

    

    AlexanderLanin

    on Jan 29, 2025

    MemberAuthor

    More actions

    While pr-preview-action focuses on PR previews, our current action includes a versions file to track deployed versions.

    The idea of the version file is actually to enable front-end switching of the shown version, see #250 (just created)
11. AlexanderLanin commented on Jan 29, 2025

    

    AlexanderLanin

    on Jan 29, 2025

    MemberAuthor

    More actions

    Oh and I looked into creating a full blown JavaScript action a little while ago, which seems to be the gold standard. But back then I concluded that it was too much effort / overhead. Especially for the very first initial setup it was easier without JavaScript and custom logic, but simply combining exiting actions.

    Maybe you can provide an independent opinion?

    https://github.com/AlexanderLanin/versioned-pages
12. AlexanderLanin

    removed a parent issue on Jan 30, 2025

    • docs: usability improvements #246
13. AlexanderLanin

    added a parent issue on Jan 30, 2025

    • docs: PR preview #253
14. dcalavrezo-qorix commented on Jan 31, 2025

    

    dcalavrezo-qorix

    on Jan 31, 2025

    Last edited by dcalavrezo-qorix

    Contributor

    More actions

    Current behavior

    Short review of our current action deploy-version-pages:

    1. Determine the <target_folder>

    ---

    • If triggered by a pull request (PR), the documentation is deployed under pr-<PR_NUMBER>.
    • If triggered by a branch other than main, it is deployed under a folder named after the branch (<branch_name>).

    2. Prepare the deployment directory

    ---

    • Creates a deployment folder structure (deploy_root/<target_folder>).
    • Moves the HTML files from source_folder (input) to the appropriate target directory.
    • Creates a .nojekyll file to prevent GitHub Pages from processing the folder as a Jekyll site.
    • fetches the gh-pages branch and updates the versions file by adding the new target folder (if it doesn’t already exist)

    3. Page deployment

    ---

    • Uses the github-pages-deploy-action to push the deploy_root folder to the gh-pages branch.
    • The clean: false option ensures that previous deployments are not removed, preserving existing documentation versions.

    4. Add a comment

    ---

    • If the action is triggered by a pull request, and create_comment is true, it adds a comment on the PR with a link to the generated documentation (https://eclipse-score.github.io/score/<target_folder>)

    Potential issues

    1. There are possible race conditions, when multiple PRs modify the documentation at the same time, you might not know if the correct version is pushed to the remote <target_directory>.
    2. Deleted files aren't automatically removed unless a clean-up mechanism is added. We set the clean: false setting, which means that if a file was deleted from the source_folder it will remain in the deployed documentation instead of being deleted.
    3. On a second thought, file overwrites are also possible if branches get renamed or are recreated
15. AlexanderLanin commented on Jan 31, 2025

    

    AlexanderLanin

    on Jan 31, 2025

    Last edited by AlexanderLanin

    MemberAuthor

    More actions

    1. we have a concurrency group (see docs.yaml)

    👍React with 👍1Reacted by Dan Calavrezo
16. dcalavrezo-qorix

    added a commit that references this issue on Feb 10, 2025

    docs: allow publishing docs from forked PRs

    ...

    This issue will close once commit 97c0516 is merged into the 'main' branch.

    97c0516
17. AlexanderLanin

    closed this as completedin #327on Feb 12, 2025
18. github-project-automation

    moved this from In Progress to Done in INF - Infrastructure Communityon Feb 12, 2025