-
Notifications
You must be signed in to change notification settings - Fork 31
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
update README #515
update README #515
Conversation
Django 3.6 will be installed as the lastest version that works on python2.6
This pull request has been mentioned on Image.sc Forum. There might be relevant details there: https://forum.image.sc/t/omero-figure-dev-install-with-docker-fails/86022/5 |
Conflicting PR. Removed from build OMERO-plugins-push#47. See the console output for more details.
--conflicts |
README.rst
Outdated
|
||
|
||
To develop ``omero-figure`` you can either make all the changes within the Docker container itself by running: | ||
:: | ||
|
||
|
||
$ docker run -ti -e OMEROHOST=YOUR_HOST -p 4080:4080 figure-devel | ||
$ docker run -ti -e OMEROHOST=$HOST -p 4080:4080 figure-devel |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this is defined as $OMEROHOST
above, then you only need:
...-ti -e OMEROHOST -p ...
Conflicting PR. Removed from build OMERO-plugins-push#49. See the console output for more details.
|
…lone:latest in Dockerfile
@jburel - I can't seem to reproduce the original error reported above, so I've reverted the Dockerfile change (maybe the omero-web-standalone got updated already)? |
@will-moore I have merged the omeroweb-docker so it is now running Python 3.9 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please address #515 (comment)
Hmm - OK, now I'm confused.... The error you're seeing is what's described in the PR description above. And I worked around it at the time with But then I removed that change (to try and check the error again) and didn't see an error (maybe the Docker Image was cached and removing the change had no effect). And now @jburel comment #515 (comment) implies that we don't need the workaround any more as the omero-web standalone docker is now up-to-date (python 3.9)?? |
I have merged the omero-web-docker PR but not tagged the repository so the new docker image is not available on dockerhub. I was waiting for the next release of omero-web |
I have reverted to use |
But some problem is then detected when following the workflow in the browser, see https://github.com/ome/omero-figure/pull/515/files#r1426873071 (not claiming that it was not there before, just that the README does somehow not work as written) |
README.rst
Outdated
Using Docker | ||
************ | ||
|
||
It is also possible to develop figure in docker without installing anything locally. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is obviously not true. After consultaion, I understand that you have to install both npm and grunt for one of the workflows below (for the recommended one in fact).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tweaked this in f35ae2e
README.rst
Outdated
$ docker build -t figure-devel . | ||
$ export OMEROHOST=demo.openmicroscopy.org | ||
|
||
The preferred option is to mount the repository containing the omero-figure code. You can make the changes locally and run `grunt watch` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The preferred option is to mount the repository containing the omero-figure code. You can make the changes locally and run `grunt watch` | |
The preferred option is to mount the repository containing the omero-figure code. For this, you need to install locally ``npm`` and ``grunt`` as described above. You can make the changes locally and run `grunt watch` |
README.rst
Outdated
Using Docker | ||
************ | ||
|
||
It is also possible to develop figure in docker without installing anything locally. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is also possible to develop figure in docker without installing anything locally. | |
It is also possible to develop figure in docker without installing omero-web or omero-figure locally. |
Failed checks. @will-moore could you maybe read my suggestions in the text and accept or reformulate, then commit and we can read afresh on Monday ? I do not see any probs anymore with the workflow (although the failed checks are worrying) - it is just about formulating the README. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Have a look at the suggested reformulations of the text
Check the failed checks on PR
The failing checks are connected to flake8 install imho https://github.com/ome/omero-figure/actions/runs/7264947038/job/19793566993 - the attempt to fix them by upgrading the testing framework in #535 have failed - the flake8 error persists. Any ideas please @joshmoore @khaledk2 ? |
@pwalczysko The requirements in omero-test-infra will need to be updated see https://github.com/ome/omero-test-infra/blob/master/requirements.txt. I will not recommend to upgrade omero-test-infra before the break since many repositories will be affected (including external repo like ezomero) One option will be to work from a personal branch to get omero-figure green via the omero_plugin.yml |
Meaning pointing inside omero_plugin.yml to a personal branch on the https://github.com/ome/omero-test-infra/blob/master/requirements.txt repo ? |
@jburel @pwalczysko Thanks for your help. |
@will-moore could you remove the commit not related to the README update? |
700f29f
to
ec524fb
Compare
@jburel Done. Just the README and DockerFile changed now. |
The latest docker image has now been updated to Rocky Linux 9 so Python version will now be 3.10 |
@@ -1,4 +1,4 @@ | |||
FROM openmicroscopy/omero-web-standalone:latest | |||
FROM openmicroscopy/omero-web-standalone:5.21.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FROM openmicroscopy/omero-web-standalone:5.21.0 | |
FROM openmicroscopy/omero-web-standalone:latest |
as per @jburel's comment - this works fine for me
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this works fine for me
Sorry, have to eat my words. It works fine only up to a point. This means that the docker image builds fine, and the docker starts as expected. I am able to connect to demo server. But then:
- if using the latest image, I am not able to watch the changes live as described in this README, for example changing the
index.html
file and renaming theExport PDF
button does not appear immediately after refresh - if using the 5.21.0 image, I am able to watch the changes live, ie. the
Export PDF
button manipulation in theindex.html
is immediately visible after refresh of the browser
Adding -e CONFIG_omero_web_debug=true
to the docker run...
cmd with the latest
build image does not help, still no changes visible after refresh. Note that the changes are visible if you stop the docker and run the docker run...
cmd again - then it works even with the latest
image
README.rst
Outdated
@@ -208,6 +208,8 @@ You can refresh the Docker hosted page at http://localhost:4080/figure to see ch | |||
$ cd /PATH_TO_GIT_REPO/omero-figure | |||
$ grunt build | |||
$ grunt watch # to see updates | |||
|
|||
# in a different terminal... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the cmd below you are using the OMEROHOST variable which was defined in the previous terminal. Maybe move the OMEROHOST definition to here instead ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@pwalczysko instead, I switched the order you launch these so that grunt
is in a different terminal and you launch docker first in the terminal that does have OMEROHOST - see a6940e1
Decided that we don't want to keep supporting Docker for omero-web development. Takes too much testing (as above) and maintenance. |
Issues with Docker-based dev instructions at https://forum.image.sc/t/omero-figure-dev-install-with-docker-fails/86022
prompted me to tidy them (fix formatting) and add the option of local install.
NB: However, as noted on that issue, the instructions won't work because
openmicroscopy/omero-web-standalone:latest
Docker image is still python 3.6, which forces Django 3.2 to be installed, which is incompatible (in development mode) with ome/omero-web#480 which was included inomero-web 5.22.0
.Can try to use older omero-web in Dockerfile...
FROM openmicroscopy/omero-web-standalone:5.21.0