Skip to content

Commit

Permalink
update CI to run 1.10 (LTS) and 1.11 (current minor release)
Browse files Browse the repository at this point in the history
  • Loading branch information
thomvet committed Oct 31, 2024
1 parent 8beb9e7 commit 01a875e
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 7 deletions.
7 changes: 1 addition & 6 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,7 @@ jobs:
- Core
version:
- '1'
- 'pre'
include:
# run 1.6 only on Windows, Mac OS on current github runners doesn't work, see: https://github.com/julia-actions/setup-julia/issues/240
# and on ubuntu it runs for disproportionate times.
- platform: windows-latest
version: 1.6
- 'lts'
runs-on: ${{ matrix.platform }}
steps:
- uses: actions/checkout@v4
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,14 @@ accidental breakage and evolutions of the API have to be expected.

Documentation is also a work in progress.

## How to contribute
There is many ways one can contribute to the development of Open62541.jl (in order of increasing complexity):
- Reporting bugs, issues and suggestions on the Github repository.
- Improving the clarity of the existing documentation.
- Adding new tutorials for more advanced functionality.
- Adding/Improving docstrings, especially in the main file of the library src/Open62541.jl. It would be best if these are added automatically in the right spot during the code generation using Clang.jl (see gen/generator.jl). But improvements are welcome also if they are directly done in the src/Open62541.jl (existing contributors can help keeping things aligned).
- Adding improvements to the high-level interface. It would be best to discuss ideas on this topic via the Github repository before embarking on larger changes.

## Installation

Open62541.jl is registered in Julia's General registry.
Expand Down
8 changes: 8 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,11 @@ The documentation has the following structure:

The docstring situation is better on the handwritten functions contained in
the other source files.

## How to contribute
There is many ways one can contribute to the development of Open62541.jl (in order of increasing complexity):
- Reporting bugs, issues and suggestions on the Github repository.
- Improving the clarity of the existing documentation.
- Adding new tutorials for more advanced functionality.
- Adding/Improving docstrings, especially in the main file of the library src/Open62541.jl. It would be best if these are added automatically in the right spot during the code generation using Clang.jl (see gen/generator.jl). But improvements are welcome also if they are directly done in the src/Open62541.jl (existing contributors can help keeping things aligned).
- Adding improvements to the high-level interface. It would be best to discuss ideas on this topic via the Github repository before embarking on larger changes.
2 changes: 1 addition & 1 deletion docs/src/tutorials/further_resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ tutorials is of course written in C, many of the function names and approaches
directly transfer over to Open62541.jl and are thus very useful to know.

## Examples in the open62541 source repository on Github
The [examples](https://github.com/open62541/open62541/tree/master/examples)
The [examples](https://github.com/open62541/open62541/tree/master/examples) provided in Github repository of the open62541 C-library can also be instructive. Many of the tests of the Julia library have been adapted from examples found in this folder, so it is useful to compare the two codes against each other.

## Tests in Open62541.jl
Code changes implemented in Open62541.jl are continuously tested against a growing
Expand Down

0 comments on commit 01a875e

Please sign in to comment.