Skip to content

Commit

Permalink
More info to user-facing readme
Browse files Browse the repository at this point in the history
  • Loading branch information
elisabettai committed Apr 17, 2024
1 parent dd47377 commit ce7c699
Showing 1 changed file with 23 additions and 9 deletions.
32 changes: 23 additions & 9 deletions {{cookiecutter.project_slug}}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,30 @@
- [``Docker``](https://docs.docker.com/get-docker/) (if you wish to build and test the service locally)

## Workflow
### Create the Service
1. Add your additional libraries to the appropriate in file [`env-config`](./env-config/)
2. The [Dockerfile]({{ cookiecutter.project_slug }}/src/Dockerfile) shall be modified to install additional packages, software and/or Jupyter kernels
3. The [.osparc](.osparc) is the configuration folder and source of truth for metadata: describes service info and expected inputs/outputs of the service. If you need to change the inputs/outputs of the service, description, thumbnail, etc... check the [`metadata.yml`](./.osparc/metadata.yml) file
4. Optional: if you need to change the default the start-up behavior of the service, modify the [`boot_notebook.bash`](./boot_scripts/boot_notebook.bash) file
5. The service docker image may be built with ``make build`` (see "Useful Commands" below)
6. The service docker image may be run locally with ``make run-local`` (see "Useful Commands" below)
7. Once you are happy with your code, an automated pipeline will build the Docker image for you (as in step 5)
8. If you wish to publish you your Service on the o²S²PARC platform, get in touch with [o²S²PARC Support](mailto:support@osparc.io)

After the initial version, you can update your Service and publish a new version, with ``make version-patch``, or ``make version-minor``, or ``make version-major``
2. The [Dockerfile]({{cookiecutter.project_slug}}/src/Dockerfile) shall be modified to install additional packages, software and/or Jupyter kernels (if something is need in addition to 1.)
3. Optional: the [.osparc](.osparc) is the configuration folder and source of truth for metadata: describes service info and expected inputs/outputs of the service. If you need to change the inputs/outputs of the service, description, thumbnail, etc... check the [`metadata.yml`](./.osparc/metadata.yml) file
4. Optional: if you need to change the start-up behavior of the service, modify the [`boot_notebook.bash`](./boot_scripts/boot_notebook.bash) file
5. Optional (for testing): The service docker image may be built with ``make build`` (see "Useful Commands" below)
6. Optional (for testing): The service docker image may be run locally with ``make run-local`` (see "Useful Commands" below)

### Publish the Service on o²S²PARC
Once you're happy with your code:
1. Push it to a public repository.
2. An automated pipeline will build the Docker image for you (as in step 5), via GitHub actions or a GitLab CI (see `.github` or `.gitlab` folders)
3. Check that the automated pipeline executes successfully
4. Once the pipeline has run successfully, get in touch with [o²S²PARC Support](mailto:support@osparc.io), we will take care of the final steps!

### Change the Service (after it has been published on o²S²PARC )
If you wish to change your Service (e.g. add additional librarie), after it has been published on o²S²PARC, you have to **create a new version**:
1. Go back to your repository
2. Apply the desired changes
3. Increase ("bump") the Service version: in your console execute: ``make version-patch``, or ``make version-minor``, or ``make version-major``
4. Commit and push the changes to your repository
5. Wait for the GitHub/GitLab pipelines to run successfully
5. Once the pipeline has run successfully, get in touch with [o²S²PARC Support](mailto:support@osparc.io), we will take care of tpublishing the new version!


### Useful commands
```console
Expand Down

0 comments on commit ce7c699

Please sign in to comment.