Skip to content

infra: docs-as-code setup#3

Merged
MaximilianSoerenPollak merged 11 commits into
mainfrom
basics
May 22, 2026
Merged

infra: docs-as-code setup#3
MaximilianSoerenPollak merged 11 commits into
mainfrom
basics

Conversation

@AlexanderLanin
Copy link
Copy Markdown
Member

No description provided.

@AlexanderLanin AlexanderLanin changed the base branch from dev to main May 22, 2026 09:17
@AlexanderLanin AlexanderLanin marked this pull request as ready for review May 22, 2026 09:39
AlexanderLanin

This comment was marked as outdated.

Comment thread .github/workflows/pr.yml
Comment thread .github/workflows/deploy-pages.yml

This comment was marked as outdated.

Comment thread .github/workflows/deploy-pages.yml Outdated
@AlexanderLanin

This comment was marked as outdated.

Copy link
Copy Markdown
Member Author

@AlexanderLanin AlexanderLanin left a comment

Choose a reason for hiding this comment

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

AI-assisted review (Claude):

Critical: 1 | Important: 1 | Suggestions: 1

Progress since last review: The tar pipeline is fixed cleanly — both the broken extraction step and the stale tar creation were removed. The basics push trigger is gone. Two prior findings are now resolved.

Still open:

  • Critical$TARGET undefined in Extend versions.json (see inline comment). This corrupts versions.json on every deployment.
  • Important — Artifact action version mismatch: upload-artifact@v7.0.1 (pr.yml) vs download-artifact@v8.0.1 (deploy-pages.yml). Align to the same major version.
  • Suggestion — No cleanup on PR close. pr-N/ folders and their versions.json entries accumulate forever. Copilot flagged this too. Add a workflow triggered on pull_request: [closed] that removes the folder and the corresponding versions.json entry.

Comment thread .github/workflows/deploy-pages.yml
Copy link
Copy Markdown

@MaximilianSoerenPollak MaximilianSoerenPollak left a comment

Choose a reason for hiding this comment

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

Looks good overall.
Just some nitpicks / questions though

Comment thread .github/workflows/deploy-pages.yml Outdated
Comment thread .github/workflows/deploy-pages.yml
Comment thread .github/workflows/pr.yml

- name: Build documentation
run: |
bazel run //:docs -- --github_user=${{ github.repository_owner }} --github_repo=${{ github.event.repository.name }}
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Should enable --lockfile_mode=error here too no, to be consitent with the rest of S-Core?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Docs should not fail because of lockfiles. Lockfiles should fail because of lockfiles 🔒

But since we dont have proper "buy-in" on https://github.com/eclipse-score/cicd-workflows/blob/main/.github/workflows/on-pr.yml I have excluded it for now.

Comment thread .github/CODEOWNERS
# It's just the usual maintainer assignment that we perform per repository.
# It will be updated as the repository evolves, based on real life experience on who is actively maintaining (not contributing to!!) the repository.

* @AlexanderLanin @MaximilianSoerenPollak @dcalavrezo-qorix @pawelrutkaq @PiotrKorkus @lurtz @nradakovic @opajonk @antonkri @FScholPer @anmittag
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I think for now this makes sense.

Might be good for future itterations to have certain people review changes in certain folders that pretend to them.
Like infra for us, or testing for piotr etc.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I dont want a setup like in score, where it is plain impossible to land a cross topic PR

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

That's true.

Though I mean here it would make almost more sense cause it strictly is 'just' documentation.
But ye i agree it makes sense to keep it like this for now.

Comment thread BUILD Outdated
Comment thread MODULE.bazel
Copy link
Copy Markdown

@MaximilianSoerenPollak MaximilianSoerenPollak left a comment

Choose a reason for hiding this comment

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

All issues addressed.
Looks alright to me.

@MaximilianSoerenPollak MaximilianSoerenPollak merged commit 1088bc4 into main May 22, 2026
2 checks passed
@MaximilianSoerenPollak MaximilianSoerenPollak deleted the basics branch May 22, 2026 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants