Skip to content

move docs deployment to fastly service #79

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

Merged
zkat merged 1 commit into from
Dec 3, 2025
Merged

move docs deployment to fastly service #79

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
Binary file modified .DS_Store
View file
Open in desktop
Binary file not shown.
16 changes: 11 additions & 5 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ on:

env:
RUSTFLAGS: -Dwarnings
DOCS_FASTLY_API_TOKEN: ${{ secrets.DOCS_FASTLY_API_TOKEN }}
DOCS_FASTLY_SERVICE_ID: ${{ vars.DOCS_FASTLY_SERVICE_ID }}
DOCS_FASTLY_KVSTORE_NAME: ${{ vars.DOCS_FASTLY_KVSTORE_NAME }}

jobs:
rustfmt:
Expand Down Expand Up @@ -71,7 +74,7 @@ jobs:
- uses: extractions/setup-just@v3

- uses: actions-rust-lang/setup-rust-toolchain@v1

- name: Build WebAssembly module
run: just

Expand All @@ -82,8 +85,11 @@ jobs:
uses: mattnotmitt/doxygen-action@v1.9.5

- name: Deploy docs
uses: JamesIves/github-pages-deploy-action@v4
if: github.ref == 'refs/heads/main'
with:
branch: gh-pages
folder: docs # The folder the action should deploy.
env:
FASTLY_API_TOKEN: ${{ env.DOCS_FASTLY_API_TOKEN }}
run: |
npx -y @fastly/compute-js-static-publish@7 --root-dir=./docs --output=./docs-compute-cpp --service-id=${{ env.DOCS_FASTLY_SERVICE_ID }} --kv-store-name=${{ env.DOCS_FASTLY_KVSTORE_NAME }}
cd ./docs-compute-cpp
npm install
npm run fastly:publish
2 changes: 1 addition & 1 deletion Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "fastly-sys"
version = "0.5.0"
version = "0.6.0"
Copy link

@posborne posborne Dec 3, 2025

Choose a reason for hiding this comment

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

Just double checking that this bump should be included in this changeset. If it is, I would expect changes in Cargo.lock as well.

Copy link
Collaborator Author

@zkat zkat Dec 3, 2025

Choose a reason for hiding this comment

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

oh I poked at it, but it doesn't have an effect on anything. We don't publish this package and this version doesn't show up anywhere.

authors = ["Kat Marchán <kat.marchan@fastly.com>", "Sy Brand <sy.brand@fastly.com>"]
edition = "2024"

Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
This SDK is lets you use Fastly Compute platform directly with C++, using a
C++-native API with all the usual facilities of modern C++. In case you got to
this page from elsewhere, the full documentation is available online at [this
link](https://cuddly-adventure-lrw9z3m.pages.github.io).
link](https://cpp-compute-sdk.fastly.dev).

### Examples

Expand Down
Empty file removed docs/.nojekyll
View file
Open in desktop
Empty file.
2 changes: 1 addition & 1 deletion quickstart/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ curl -d "hello, world!" http://127.0.0.1:7676/
### Documentation

Online documentation can be accessed
[here](https://cuddly-adventure-lrw9z3m.pages.github.io/).
[here](https://cpp-compute-sdk.fastly.dev/).

The quickstart tarball also includes the HTML reference docs in
`docs/index.html`, which you can open locally. If you've configured your editor
Expand Down