Skip to content

Fix release failures #1530

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Fix release failures #1530

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
10 changes: 6 additions & 4 deletions HOWTO.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,13 +170,13 @@ It's highly recommended to use the docker container to run the release process,
the docker container can be pulled from DockerHub and launched via this command:

```sh
docker run -v $PWD:/mnt/workspace -i -t swiftnav/libsbp-build:2025-02-10
docker run -v $PWD:/mnt/workspace -i -t swiftnav/libsbp-build:2025-10-29
```

You can invoke individual stages like so:

```sh
docker run -v $PWD:/mnt/workspace -i -t swiftnav/libsbp-build:2025-02-10 \
docker run -v $PWD:/mnt/workspace -i -t swiftnav/libsbp-build:2025-10-29 \
/bin/bash -c "make python"
```

Expand Down Expand Up @@ -234,10 +234,10 @@ and something needs to be repeated.
make java jsonschema protobuf
```

For C, Haskell and JavaScript (JavaScript, make needs to be run twice to update the package information):
For C, Haskell and Rust:

```sh
make c haskell javascript rust
make c haskell rust
git add c/include/libsbp/version.h haskell/sbp.cabal rust/sbp/Cargo.toml
git commit --amend -a -m 'Release <INCREMENTED_TAG>'
git tag -f -a INCREMENTED_TAG -m "Version INCREMENTED_TAG of libsbp."
Expand All @@ -250,6 +250,7 @@ and something needs to be repeated.
make javascript
git add javascript/sbp/RELEASE-VERSION package.json package-lock.json
git commit --amend -a -m 'Release <INCREMENTED_TAG>'
git tag -f -a INCREMENTED_TAG -m "Version INCREMENTED_TAG of libsbp."
```

For Kaitai
Expand All @@ -258,6 +259,7 @@ and something needs to be repeated.
make kaitai
git add kaitai/ksy/sbp.ksy
git commit --amend -a -m 'Release <INCREMENTED_TAG>'
git tag -f -a INCREMENTED_TAG -m "Version INCREMENTED_TAG of libsbp."
```

4. Build the docs:
Expand Down
2 changes: 1 addition & 1 deletion python/docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []
exclude_patterns = ['sbp.jit.rst']
Copy link
Contributor Author

@Madhunika-atmakuri Madhunika-atmakuri Nov 11, 2025

Choose a reason for hiding this comment

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

sbp.jit was removed in #1519 by @dgburr
but Sphinx auto-discovers it and throws an error since it's not in the toctree. Adding this to exclude patterns fixed the release script. I'm not sure if there any permanent fix for this.

Copy link
Contributor Author

@Madhunika-atmakuri Madhunika-atmakuri Nov 11, 2025

Choose a reason for hiding this comment

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

Apologies. It turns out to be caching issue. I will revert this change


# The reST default role (used for this markup: `text`) to use for all
# documents.
Expand Down