Skip to content
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.

Sign up for GitHub

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 with steps to create new release image #12

Merged
merged 2 commits into from
Apr 29, 2024
Merged

update readme with steps to create new release image #12

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2634e4b
update read me with steps to create new release image
roshkhatri Apr 10, 2024
d92755a
Update README
roshkhatri Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


## How to build and publish new version Docker Image?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When we have a new version release from valkey

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

1. Validate if the metadata for the new version is updated at https://github.com/valkey-io/valkey-hashes/blob/main/README
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

2. If its a new major version create a new dir. For example `7.2`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

4. Validate if the version and the info is populated correctly.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how do I validate this?

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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".

10 changes: 10 additions & 0 deletions temp.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
#!/bin/bash
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this file for? :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this was a temp file where I was testing some stuff


original_tags='[
valkey-container:unstable,
valkey-container:unstable-bookworm
]'

converted_list=$(echo $original_tags | sed 's/valkey-container/valkey\/valkey/g'| sed 's/\[ *//; s/ *\]//; s/ //g')
echo $converted_list

Loading