Skip to content

Commit

Permalink
Adjust documentation for v0.5 release
Browse files Browse the repository at this point in the history
  • Loading branch information
jschwe committed May 11, 2024
1 parent f67548d commit 2551368
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
16 changes: 8 additions & 8 deletions .github/workflows/gh-pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ concurrency:
cancel-in-progress: true

jobs:
# Build and deploy the documentation of master and the stable/v0.4 branch
# Build and deploy the documentation of master and the stable/v0.5 branch
deploy:
runs-on: ubuntu-latest
environment:
Expand All @@ -36,18 +36,18 @@ jobs:
uses: actions/checkout@v4
with:
path: main
- name: Checkout stable/v0.4
- name: Checkout stable/v0.5
uses: actions/checkout@v4
with:
path: stable-v0.4
ref: 'stable/v0.4'
path: stable-v0.5
ref: 'stable/v0.5'
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Build mdbook for main branch
working-directory: 'main/doc'
run: mdbook build
- name: Build mdbook for stable/v0.4 branch
working-directory: 'stable-v0.4/doc'
- name: Build mdbook for stable/v0.5 branch
working-directory: 'stable-v0.5/doc'
run: mdbook build
# Override mdbooks default highlight.js with a custom version containing CMake support.
- uses: actions/checkout@v4
Expand All @@ -66,9 +66,9 @@ jobs:
cp highlightjs/build/highlight.min.js main/doc/book/highlight.js
cp highlightjs/build/highlight.min.js stable-v0.4/doc/book/highlight.js
- name: Copy stable doc into main
run: mkdir main/doc/book/v0.4 && cp -a stable-v0.4/doc/book/. main/doc/book/v0.4/
run: mkdir main/doc/book/v0.5 && cp -a stable-v0.5/doc/book/. main/doc/book/v0.5/
- name: Debug print
run: ls -la main/doc/book/v0.4
run: ls -la main/doc/book/v0.5
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ include(FetchContent)
FetchContent_Declare(
Corrosion
GIT_REPOSITORY https://github.com/corrosion-rs/corrosion.git
GIT_TAG v0.4 # Optionally specify a commit hash, version tag or branch here
GIT_TAG v0.5 # Optionally specify a commit hash, version tag or branch here
)
FetchContent_MakeAvailable(Corrosion)
Expand Down
4 changes: 2 additions & 2 deletions doc/src/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ the rust target.

## Requirements

- Corrosion supports CMake 3.15 and newer with the v0.4 release. If you are using the v0.4 release, please
view [the documentation here](./v0.4/introduction.md)
- Corrosion supports CMake 3.15 and newer with the v0.5 release. If you are using the v0.5 release, please
view [the documentation here](./v0.5/introduction.md)
- The master branch of Corrosion currently requires CMake 3.22 or newer.

[`target_link_libraries()`]: https://cmake.org/cmake/help/latest/command/target_link_libraries.html
2 changes: 1 addition & 1 deletion doc/src/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ include(FetchContent)
FetchContent_Declare(
Corrosion
GIT_REPOSITORY https://github.com/corrosion-rs/corrosion.git
GIT_TAG v0.4 # Optionally specify a commit hash, version tag or branch here
GIT_TAG v0.5 # Optionally specify a commit hash, version tag or branch here
)
# Set any global configuration variables such as `Rust_TOOLCHAIN` before this line!
FetchContent_MakeAvailable(Corrosion)
Expand Down
2 changes: 1 addition & 1 deletion doc/src/setup_corrosion.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ include(FetchContent)
FetchContent_Declare(
Corrosion
GIT_REPOSITORY https://github.com/corrosion-rs/corrosion.git
GIT_TAG v0.4 # Optionally specify a commit hash, version tag or branch here
GIT_TAG v0.5 # Optionally specify a commit hash, version tag or branch here
)
# Set any global configuration variables such as `Rust_TOOLCHAIN` before this line!
FetchContent_MakeAvailable(Corrosion)
Expand Down

0 comments on commit 2551368

Please sign in to comment.