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.

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

ci: Build the documents #82

Merged
merged 6 commits into from
Nov 7, 2024

Conversation

abetomo
Copy link
Contributor

@abetomo abetomo commented Nov 6, 2024

Prepare to deploy documents automatically with CI.
First, we set up CI to build the document.

Prepare to deploy documents automatically with CI.
First, we set up CI to build the document.
Copy link
Member

Choose a reason for hiding this comment

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

doc.ymldocument.ymlかな。

- name: Build documents
run: |
cmake -S groonga -B /tmp/groonga.build --preset=doc
(cd groonga && rake release:document:update BUILD_DIR=/tmp/groonga.build GROONGA_ORG_DIR=../)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
(cd groonga && rake release:document:update BUILD_DIR=/tmp/groonga.build GROONGA_ORG_DIR=../)
rake -C groonga release:document:update BUILD_DIR=/tmp/groonga.build GROONGA_ORG_DIR=../

Copy link
Contributor Author

Choose a reason for hiding this comment

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

make なやつだから -C 使えたんか。

on:
push:
branches:
- main
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- main
- gh-pages

@@ -0,0 +1,34 @@
name: Publish
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
name: Publish
name: Document

Comment on lines 12 to 13
build:
name: Build and Publish
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
build:
name: Build and Publish
publish:
name: Publish

groonga/setup.sh
pip install -r groonga/doc/requirements.txt
(cd groonga/doc && bundle install)
- name: Build documents
Copy link
Member

Choose a reason for hiding this comment

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

英語圏の人たちはdocumentsと言っているような気はするし、groonga.org/docs/だけど、他のところでdocにしちゃったんだよなぁ。どっちに合わせるのがいいかしら。

Suggested change
- name: Build documents
- name: Build document

Copy link
Contributor Author

Choose a reason for hiding this comment

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

省略しないやつはあまり気にしたことがなかったですが、省略形は docs が多い感じがします。

Copy link
Member

Choose a reason for hiding this comment

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

s付きに寄せていくかー

@kou kou merged commit 45ee865 into groonga:gh-pages Nov 7, 2024
1 check passed
@abetomo abetomo deleted the prepare-to-publish-automatically branch November 7, 2024 06:14
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