update readme with steps to create new release image #12

roshkhatri · 2024-04-10T22:03:33Z

Update readme with steps to create new release image

When to build and publish new Docker Image?

After a new major, minor or patch version of Valkey is released on https://github.com/valkey-io/valkey.

How to build and publish new version Docker Image?

Pre-requisites: Fork this repo, create a private dockerhup repo and setup the Github secrets to access the private dockerhup repo.

Validate if the metadata for the new version is updated at https://github.com/valkey-io/valkey-hashes/blob/main/README - If it is not updated, please open an issue here https://github.com/valkey-io/valkey-hashes/issues
If a new major or minor version is released, please create a new dir in the valkey-container repo. For example 7.2.
Run the update.sh script locally, which will update the versions.json and also populate the Dockerfiles for the new versions in the respective directories. Running the update.sh file, executes the versions.sh which updates the versions.json file with the required metadata from https://github.com/valkey-io/valkey-hashes/blob/main/README. Once versions.json is updated, apply-templates.sh is executed which updates Docker files for all the versions directories in the repo (For example, 7.2).
Validate if the version and the info is populated correctly from the https://github.com/valkey-io/valkey-hashes/blob/main/README file.
See if all the tests pass on your fork and the your private docker hub has been updated.
Update the dockerhub-description.md with the updated tags in your private docker hub and the Docker files links.
Publish a PR with these changes. For example: Adds 7.2.4-rc1 #8
Once the PR is merged, Sit back, relax and enjoy looking at your creation getting published to the official Docker hub page.

Signed-off-by: Roshan Khatri <[email protected]>

parthpatel

Hey, the README.md looks fine if everything succeeds in first attempt. But otherwise I don't understand the details, so asked a bunch of questions on PR.

parthpatel · 2024-04-10T23:09:05Z

README.md

@@ -3,3 +3,12 @@ This Project is the Git repo of the [Valkey "Official Image"](https://hub.docker
 The Project is now maintained by [the Valkey Community](https://github.com/valkey-io/valkey/) 
 and it was forked from https://github.com/docker-library/redis.


Do we really want to keep this reference? The other project is still an active project and probably under the same license as Redis.

It is maintained by dicker community and is under BSD, we can keep it.

parthpatel · 2024-04-10T23:10:09Z

README.md

@@ -3,3 +3,12 @@ This Project is the Git repo of the [Valkey "Official Image"](https://hub.docker
 The Project is now maintained by [the Valkey Community](https://github.com/valkey-io/valkey/) 
 and it was forked from https://github.com/docker-library/redis.

+## How to build and publish new version Docker Image?


Also, when to build and publish new version docker image?

When we have a new version release from valkey

parthpatel · 2024-04-10T23:10:15Z

README.md

@@ -3,3 +3,12 @@ This Project is the Git repo of the [Valkey "Official Image"](https://hub.docker
 The Project is now maintained by [the Valkey Community](https://github.com/valkey-io/valkey/) 
 and it was forked from https://github.com/docker-library/redis.

+## How to build and publish new version Docker Image?
+*Pre-requisites: Fork this repo, create a private dockerhup repo and setup the Github secrets to access the private dockerhup repo.*


link https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo

parthpatel · 2024-04-10T23:11:30Z

README.md

@@ -3,3 +3,12 @@ This Project is the Git repo of the [Valkey "Official Image"](https://hub.docker
 The Project is now maintained by [the Valkey Community](https://github.com/valkey-io/valkey/) 
 and it was forked from https://github.com/docker-library/redis.

+## How to build and publish new version Docker Image?
+*Pre-requisites: Fork this repo, create a private dockerhup repo and setup the Github secrets to access the private dockerhup repo.*
+1. Validate if the metadata for the new version is updated at https://github.com/valkey-io/valkey-hashes/blob/main/README


What if the hashes file is not updated, but I want to release new docker image? May be explain the background behind each step?

I am working on automating this process, so once a new release is pushed the hashes will be updated

parthpatel · 2024-04-10T23:12:24Z

README.md

+## How to build and publish new version Docker Image?
+*Pre-requisites: Fork this repo, create a private dockerhup repo and setup the Github secrets to access the private dockerhup repo.*
+1. Validate if the metadata for the new version is updated at https://github.com/valkey-io/valkey-hashes/blob/main/README
+2. If its a new major version create a new dir. For example `7.2`.


create a new dir where? Does it matter if I create it in /tmp? Is 7.2 a hyperlink?

In the valkey-container directory. I will link the example PR

parthpatel · 2024-04-10T23:14:43Z

README.md

+*Pre-requisites: Fork this repo, create a private dockerhup repo and setup the Github secrets to access the private dockerhup repo.*
+1. Validate if the metadata for the new version is updated at https://github.com/valkey-io/valkey-hashes/blob/main/README
+2. If its a new major version create a new dir. For example `7.2`.
+3. Run the `update.sh` script locally, which will update the `versions.json` and also populate the Dockerfiles for the new versions in the repective directories.


All of this sh files have 0 documentation or comments. May be elaborate on what is happening? Why is it needed?

parthpatel · 2024-04-10T23:15:13Z

README.md

+1. Validate if the metadata for the new version is updated at https://github.com/valkey-io/valkey-hashes/blob/main/README
+2. If its a new major version create a new dir. For example `7.2`.
+3. Run the `update.sh` script locally, which will update the `versions.json` and also populate the Dockerfiles for the new versions in the repective directories.
+4. Validate if the version and the info is populated correctly.


how do I validate this?

parthpatel · 2024-04-10T23:16:43Z

README.md

+4. Validate if the version and the info is populated correctly.
+5. See if all the tests pass on your fork and the your private docker up has been updated. 
+5. Publish a PR with these changes. For example: https://github.com/valkey-io/valkey-container/pull/8
+6. Once the PR is merged, Sit back, relax and enjoy looking at your creation getting publish to the official Docker hub page. 


You should explain a little more here. What goes into getting this published to official docker hub page? Are there any failures to look out for?
Also there is a typo - "getting published".

parthpatel · 2024-04-10T23:17:07Z

temp.sh

@@ -0,0 +1,10 @@
+#!/bin/bash


What is this file for? :)

this was a temp file where I was testing some stuff

Signed-off-by: Roshan Khatri <[email protected]>

parthpatel

LGTM

roshkhatri force-pushed the update-readme branch from c8ce0f9 to bd415bb Compare April 10, 2024 22:03

roshkhatri requested review from parthpatel, hpatro and madolson April 10, 2024 22:05

update read me with steps to create new release image

2634e4b

Signed-off-by: Roshan Khatri <[email protected]>

roshkhatri force-pushed the update-readme branch from bd415bb to 2634e4b Compare April 10, 2024 22:07

parthpatel reviewed Apr 10, 2024

View reviewed changes

Update README

d92755a

Signed-off-by: Roshan Khatri <[email protected]>

roshkhatri requested a review from parthpatel April 23, 2024 00:34

parthpatel approved these changes Apr 25, 2024

View reviewed changes

roshkhatri merged commit 7c9b4ef into valkey-io:mainline Apr 29, 2024
8 checks passed

roshkhatri deleted the update-readme branch September 4, 2024 20:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update readme with steps to create new release image #12

update readme with steps to create new release image #12

roshkhatri commented Apr 10, 2024 •

edited

Loading

parthpatel left a comment

parthpatel Apr 10, 2024

roshkhatri Apr 23, 2024

parthpatel Apr 10, 2024

roshkhatri Apr 12, 2024

parthpatel Apr 10, 2024

parthpatel Apr 10, 2024

roshkhatri Apr 15, 2024

parthpatel Apr 10, 2024

roshkhatri Apr 15, 2024

parthpatel Apr 10, 2024

parthpatel Apr 10, 2024

parthpatel Apr 10, 2024

parthpatel Apr 10, 2024

roshkhatri Apr 12, 2024

parthpatel left a comment

		@@ -3,3 +3,12 @@ This Project is the Git repo of the [Valkey "Official Image"](https://hub.docker
		The Project is now maintained by [the Valkey Community](https://github.com/valkey-io/valkey/)
		and it was forked from https://github.com/docker-library/redis.

update readme with steps to create new release image #12

update readme with steps to create new release image #12

Conversation

roshkhatri commented Apr 10, 2024 • edited Loading

When to build and publish new Docker Image?

How to build and publish new version Docker Image?

parthpatel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

parthpatel left a comment

Choose a reason for hiding this comment

roshkhatri commented Apr 10, 2024 •

edited

Loading