opensafely-core / research-template-docker

This provides the devcontainer Docker image used by repos created from the OpenSAFELY research template.
Other
0 stars 0 forks source link

Move postAttach and postCreate actions to Dockerfile #29

Closed Jongmassey closed 3 weeks ago

Jongmassey commented 1 month ago

The research template devcontainer.json contains a postCreateCommand setting and postAttachCommand setting. Currently the former calls .devcontainer/postCreate.sh (which is included in the research template repo), and the latter starts rstudio server.

If we wish to make changes to what happens on either of these events, then this currently requires making changes to the research template which:

I propose that:

Acceptance criteria

Note: we should keep an eye on how long this work takes and maybe reconsider if it potentially takes us beyond 28th June.

StevenMaude commented 3 weeks ago

Repository changes

Documentation changes

I don't think that the documentation for adding Codespaces to a project needs updating The steps to update are the same, and there are still multiple files to copy across to a project.

If we need to describe the upgrade path, the simplest way to do so would be:

  1. Delete the existing files out of .devcontainer in your project.
  2. Repeat the steps for "Adding Codespaces to your project".

PR to explain the upgrade path (which isn't documented):

StevenMaude commented 3 weeks ago

I think merging the PRs above should be sufficient to close this issue.

StevenMaude commented 3 weeks ago

Closing as the related PRs are now merged.