Skip to content
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.

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

Suggestion: READ.me should be updated to not suggest release branch as the default. #20

Open
BJackal opened this issue May 29, 2024 · 2 comments
Assignees

Comments

@BJackal
Copy link

BJackal commented May 29, 2024

Currently the READ.me for Chaste docker suggests pulling in the release branch as the default branch.

docker run --init -it --rm -v chaste_data:/home/chaste chaste/release

The current release branch is 3 years old an causes a lot of issues in regards to vertex based models. Often leading to unclear CellVecData errors. I would suggest instead that the default for the docker image should be set to develop. Likely also containing many other issues that a new branch no longer has.

docker run --init -it --rm -v chaste_data:/home/chaste chaste/develop

This will require a bit of updating throughout some of the documentation and perhaps Docker file but I have opened a new branch to do this on. Happy to go through and do this but thought it best to discuss first.

@mirams
Copy link
Member

mirams commented May 29, 2024

Hmmm, I think the idea might have been making the release branch defunct. But I do like the idea of a 'pull in latest stable release' as a tagged branch and then you can get any 'hotfix' type things, although this will tend to happen in develop anyway.

I guess @fcooper8472 we should either update release branch to point at latest release (within release instructions/procedure), or remove it altogether.

@bdevans
Copy link
Member

bdevans commented May 29, 2024

Perhaps slightly confusingly, the command:

docker run --init -it --rm -v chaste_data:/home/chaste chaste/release

does not actually use the release branch - it pulls a docker image built using the latest tagged release (2024.1 at the time of writing).

I don't mind change the instructions to use the other command though if that's the consensus as the chaste/develop image is indeed built from the develop branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants