Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
agt authored Oct 6, 2023
1 parent 39f6a28 commit ef7012e
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,38 @@
# COURSE Jupyter notebook

## Automated Builds

A new version of the image is built whenever the repository is updated. The tag of the build is the same as the branch.

## How to create a release

First, determine on the tag to use. It's recommended to use the current quarter. The tag would be "sp23" for spring 2023.

Open the [Releases](../../releases) page and click the `Create a new release` button. Enter the tag in the "Choose a Tag" field and press enter to confirm. Then click "Publish Release" to create the tag.

You can also create a release using the git CLI.

git tag sp23
git push origin sp23

## How to re-release

Re-releasing is the same as making a release, except that we need to delete the existing release.

Open the [Releases](../../releases) page, click the Releases tab, and delete the release.

Open the [Releases](../../releases) page, click the Tags tab, and delete the tag.

And for CLI users

git -d sp23
git push ---delete origin sp23

Now that the tag and release are gone, follow the "How to create a release" instructions.




# Instructions on Building a Custom Image for DataHub/DSMLP

This guide is for advanced DSMLP users (both students and instructors) who want to add or modify applications on their working environment using a custom Docker container.
Expand Down

0 comments on commit ef7012e

Please sign in to comment.