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

Build the manual using mdbook and redirect old page #226

Merged
merged 1 commit into from
Feb 1, 2025
+42 −1,121
Merged

Build the manual using mdbook and redirect old page #226

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ on:
push:
branches:
- src
schedule:
Copy link
Member

Choose a reason for hiding this comment

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

Do we want this? It might be confusing for the users if the manual includes features that aren't available in the stable release yet. I think we should either have nightly and stable versions, or just stable.

Copy link
Member

Choose a reason for hiding this comment

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

Yes, once a week or manually triggered as part of a release seems preferable. I wonder if we can easily setup some form cross repo triggers? (that is once a stable releases CI run finished, trigger CI here?)

Copy link
Member

Choose a reason for hiding this comment

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

Maybe let's add workflow_dispatch too, so we can trigger it manually.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Neat, I didn't know you could do that. Added.

# Every day, to pick up the latest rust-analyzer repo changes.
- cron: '0 0 * * *'
workflow_dispatch:

jobs:
CI:
Expand All @@ -16,6 +20,31 @@ jobs:

- run: bundle install && bundle exec jekyll build

- uses: taiki-e/install-action@v2
with:
tool: [email protected]

- uses: taiki-e/install-action@v2
with:
tool: [email protected]

- name: Clone the rust-analyzer repository
uses: GuillaumeFalourd/[email protected]
with:
depth: 1
branch: 'master'
owner: 'rust-lang'
repository: 'rust-analyzer'

- name: Build generated.md files
run: cd rust-analyzer && cargo xtask codegen

- name: Run mdbook
run: cd rust-analyzer/docs/book && mdbook build

- name: Include mdbook output
run: mv rust-analyzer/docs/book/book _site

- name: Deploy
uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
with:
Expand Down
Loading