Skip to content
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

Jump to bottom

feat(docs): Add minimum configuration for CLI docs PoC #4136

Merged
merged 20 commits into from
Dec 10, 2024
Merged

feat(docs): Add minimum configuration for CLI docs PoC #4136

merged 20 commits into from
Dec 10, 2024

Conversation

SamyOubouaziz
Copy link
Contributor

@SamyOubouaziz SamyOubouaziz commented Sep 18, 2024 •
edited
Loading

Scaleway CLI documentation PoC:

  • Added basic configuration to build website using Material for MkDocs:
    • index file (copy of repo readme)
    • yaml file: conf file
    • graphical elements (images/CSS
    • Workflow file to build and push the pages to a bucket website on each release
NONE

@SamyOubouaziz SamyOubouaziz added enhancement documentation github_actions Pull requests that update GitHub Actions code labels Sep 18, 2024
@SamyOubouaziz SamyOubouaziz self-assigned this Sep 18, 2024
@SamyOubouaziz SamyOubouaziz marked this pull request as ready for review November 28, 2024 15:41
SamyOubouaziz
SamyOubouaziz commented Nov 28, 2024
View reviewed changes
.github/workflows/deploy-docs.yml
Comment on lines +2 to +7
on:
release:
types:
- published # Triggered only when a new release is published
branches:
- master
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The expected behavior is: build and deploy when a new release is published. Could you check if this is the proper configuration?

Copy link
Contributor

Choose a reason for hiding this comment

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

yes we release on master

SamyOubouaziz
SamyOubouaziz commented Nov 28, 2024
View reviewed changes
.github/workflows/deploy-docs.yml Outdated
Comment on lines 18 to 22
ref: ${{ github.event.release.tag_name }}
- name: Verify release commit
run: | # Commit hash to compare with the commit returned by actions/checkout@v4 - Tag to compare with the latest release
echo "Checked out commit: $(git rev-parse HEAD)"
echo "Expected tag: ${{ github.event.release.tag_name }}"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This part is supposed to check out the release commit and allow to compare checked out commit and release commit/tag.

Could you check if this is set properly ?

@SamyOubouaziz SamyOubouaziz force-pushed the feat/create-cli-doc-website-poc branch from ade2ccb to 515ba4f Compare November 28, 2024 15:46
@jremy42 jremy42 added this pull request to the merge queue Dec 10, 2024
@jremy42 jremy42 removed this pull request from the merge queue due to a manual request Dec 10, 2024
@jremy42 jremy42 added this pull request to the merge queue Dec 10, 2024
Merged via the queue into master with commit ff4f3ac Dec 10, 2024
14 checks passed
@jremy42 jremy42 deleted the feat/create-cli-doc-website-poc branch December 10, 2024 10:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jremy42 jremy42 jremy42 approved these changes

@remyleone remyleone Awaiting requested review from remyleone remyleone is a code owner

Assignees

@SamyOubouaziz SamyOubouaziz

Labels
documentation enhancement github_actions Pull requests that update GitHub Actions code
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@SamyOubouaziz @jremy42