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.

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

chore: adds github actions to push faraday docker images to docker hub #187

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

NonsoAmadi10
Copy link

@NonsoAmadi10 NonsoAmadi10 commented Feb 22, 2024

What does this PR do?

How should this be tested?

To validate the effectiveness of the newly integrated GitHub Action for automating Docker image pushes to Docker Hub upon a new release, follow these steps:

  1. Trigger a New Release:

Navigate to the repository's 'Releases' section.
Create a new release. You can do this by tagging a specific commit or using the repository's latest commit. Ensure that the release process mimics the standard release procedure for this repository.

2.Verify GitHub Action Execution:

Once the release is created, go to the 'Actions' tab in the GitHub repository.
You should see a new workflow run initiated by the release action. This workflow corresponds to the GitHub Action we have added for Docker image automation.

  1. Check Workflow Logs:

Click on the workflow run to view its details.
Review the logs to ensure that the GitHub Action executed correctly without any errors. Pay special attention to the steps where the Docker image is built and pushed to Docker Hub.

  1. Inspect Docker Hub Repository:

Go to the Docker Hub repository linked to this GitHub repository.
Verify that a new Docker image has been pushed successfully. Ensure the image tag matches the release version/tag created in step 1.

5.Optional: Pull and Run the Docker Image:

As an additional verification step, you can pull the newly pushed Docker image from Docker Hub to your local machine using docker pull <image_name>:.
Run the Docker image locally to ensure it's functioning as expected.

Please note that this GitHub Action is configured to trigger only on new releases. Any direct pushes or merged PRs to the main branch will not activate this action unless they are part of a release process.

Also note that the repo admin would need to create the docker hub and add the required environment variables

Pull Request Checklist

  • Update MinLndVersion if your PR uses new RPC methods or fields of lnd.

Copy link
Member

@guggero guggero left a comment

Choose a reason for hiding this comment

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

Thanks, LGTM 🎉

@Roasbeef can you please add the required Docker Hub secrets to this repo as secrets?

DOCKER_USERNAME
DOCKER_API_KEY

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Provide a docker image on dockerhub
2 participants