search

bcube-project / BcubeTutorials.jl

Tutorials and examples for the Bcube project
MIT License
2 stars 0 forks source link

Update readme and deps #10

Closed bmxam closed 6 months ago

bmxam commented 6 months ago

Tiny PR to prepare new tag.

@ghislainb :

  1. do you want BcubeTutorials tag to match exactly Bcube tag? For the present case it would mean moving from 0.1.1 to 0.1.4. I don't think this is a good idea but I am not 100% against it.
  2. From what I understand here the preferred way to setup unit tests is now to place Test etc dependencies in a test/Project.toml folder, as in Bcube (even though in Bcube we actually do both). Do you want me to use this PR to change this?
  3. In ci.yaml, we explicitely designates Bcube with the git repo (instead of the registry). I think we should leave like this right? Otherwise I am afraid that tests will always be run with the registry-Bcube instead of the current development Bcube?
ghislainb commented 6 months ago

Tiny PR to prepare new tag.

@ghislainb :

1. do you want `BcubeTutorials` tag to match exactly `Bcube` tag? For the present case it would mean moving from 0.1.1 to 0.1.4. I don't think this is a good idea but I am not 100% against it.

2. From what I understand [here](https://pkgdocs.julialang.org/dev/creating-packages/#adding-tests-to-packages) the preferred way to setup unit tests is now to place `Test` etc dependencies in a `test/Project.toml` folder, as in Bcube (even though in Bcube we actually do both). Do you want me to use this PR to change this?

3. In `ci.yaml`, we explicitely designates `Bcube` with the git repo (instead of the registry). I think we should leave like this right? Otherwise I am afraid that tests will always be run with the registry-Bcube instead of the current development Bcube?
  1. I think if the tags for BcubeTutorials don't match, it's fine.
  2. Yes I have already seen the new approach. But as said in the "Note" of the doc, there may still potentially be problems with this method. So I don't know if it's worth changing for now.
  3. From a user perspective, I think it's better to change it and run with the lastest release. The current dev of Bcube will still be tested to run BcubeTutorials with the "integration tests" workflow