Skip to content

build: add workflow for github pages#827

Merged
diatrcz merged 25 commits into
mainfrom
lt/github-pages
Jul 23, 2026
Merged

build: add workflow for github pages#827
diatrcz merged 25 commits into
mainfrom
lt/github-pages

Conversation

@diatrcz

@diatrcz diatrcz commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Add github pages configuration through Github Actions.

diatrcz added 2 commits July 3, 2026 14:09
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
@diatrcz
diatrcz requested review from Andris28 and pyrooka July 3, 2026 12:20
@diatrcz
diatrcz marked this pull request as ready for review July 3, 2026 12:20

@pyrooka pyrooka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Overall this looks pretty good, but the deployed pages still doesn't look 100% correct. I see some markdown elements rendered there: https://ibm.github.io/openapi-validator/docs/ibm-cloud-rules.html
Can we fix it somehow?

Comment thread _config.yml

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think this file should be in the project root as that's the source directory for Jekyll in the GH Action workflow.

Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
@diatrcz
diatrcz requested a review from pyrooka July 15, 2026 14:28
diatrcz added 5 commits July 16, 2026 14:25
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
diatrcz added 2 commits July 21, 2026 13:43
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>

@pyrooka pyrooka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Few comments to address, otherwise it looks good. I like the result a lot!

Comment thread .github/workflows/github-pages.yml Outdated
@@ -0,0 +1,51 @@
# Sample workflow for building and deploying a Jekyll site to GitHub Pages

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This line should be removed I think. It's not just a sample anymore. :)

Comment thread .github/workflows/github-pages.yml Outdated
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Since cancel-in-progress is set to true this comment contradicts with the actual config, right?

Comment thread docs/ibm-cloud-rules.md Outdated
Comment on lines +782 to +781
> [!CAUTION]
> Disabling certain rules may lead to false negatives for problems identified by other rules.
> **Caution:** Disabling certain rules may lead to false negatives for problems identified by other rules.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Visually the older version is better, but I guess it's necessary to change this for Jekyll, right?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

It was an issue in the beginning making the table under it break, but since then i fixed most of the broken html parsing in the markdown file. I can check how it renders now and change it back if it doesn't break it.

Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
Signed-off-by: Lídia Tarcza <100163235+diatrcz@users.noreply.github.com>
@diatrcz
diatrcz requested a review from pyrooka July 23, 2026 12:58

@pyrooka pyrooka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good!

@diatrcz
diatrcz merged commit 913c498 into main Jul 23, 2026
9 checks passed
@diatrcz
diatrcz deleted the lt/github-pages branch July 23, 2026 14:02
@ibm-devx-sdk

Copy link
Copy Markdown

🎉 This PR is included in version 1.37.17 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants