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

Changes from all commits
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
13 changes: 13 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,16 @@ 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.


## 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?
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](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) 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 - If it is not updated, please open an issue here https://github.com/valkey-io/valkey-hashes/issues
2. If a new major or minor version is released, please create a new dir in the `valkey-container` repo. For example [`7.2`](https://github.com/valkey-io/valkey-container/tree/mainline/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 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`](https://github.com/valkey-io/valkey-container/tree/mainline/7.2)).
4. Validate if the version and the info is populated correctly from the https://github.com/valkey-io/valkey-hashes/blob/main/README file.
5. See if all the tests pass on your fork and the your private docker hub has been updated.
5. Update the `dockerhub-description.md` with the updated tags in your private docker hub and the Docker files links.
6. Publish a PR with these changes. For example: https://github.com/valkey-io/valkey-container/pull/8
7. Once the PR is merged, Sit back, relax and enjoy looking at your creation getting published to the official Docker hub page.
Loading