Implement "Keep-Alive" for Daniel Ridge bot so that Docker image will be updated

roslynwythe commented 9 months ago

Overview

We need to implement a "Keepalive Workflow" for the Daniel Ridge bot so that it performs its function of checking the dependencies for the Docker image and when necessary, updating the Dockerfile, which triggers the process of updating our Docker hub image.

Details

The Daniel Ridge Bot repo check-ghpages-versions contains scheduled workflows to automatically check the dependencies for the Docker image created from ghpages-docker. If dependencies are out of date, an issue is automatically created in github.com/hackforla/ops to update the ghphages-docker Dockerfile, which causes ghpages-docker to build a new image and push it to Docker Hub.
Due to inactivity, scheduled workflows in the Daniel Ridge Bot repo were disabled, and as a result, the Docker image has not been updated in over a year.
In #5897 the recommendation was made to use the Keepalive Workflow GitHub action to permanently enable the workflow check-gh-pages-version.yml workflow from check-ghpages-versions

Action Items

[ ] Clone the repository check-ghpages-versions.
[ ] Read and understand Daniel Ridge Bot Ops Wiki, Keep Alive Workflow and How To Use section of the Keep-Alive Workflow documentation
- [ ] Note the section "Moving the keepalive workflow into its own distinct job is strongly recommended for better security" and understand the sample code
[ ] Incorporate the Keepalive Workflow GitHub action so that it will prevent workflows from being disabled due to inactivity in the repo
[ ] For testing, modify both the workflows so that they create the issue in your repository
- [ ] .github/workflows/check-ruby-version.yml
- [ ] .github/workflows/check-gh-pages-version.yml
[ ] create a PAT in your repository, then a secret called test_Daniel_Ridge_PAT and modify each workflow to use that secret in place of GH_TOKEN: ${{ secrets.Daniel_Ridge_PAT }}
[ ] As described in How To Use section of the Keep-Alive Workflow documentation, workflow permissions must be set. Go to repository settings, Click on Actions > General. Update the "Workflow permissions" to "Read and write permissions". Click on save.
[ ] On the wiki page https://github.com/hackforla/ops/wiki/@danielridgebot-Ops-Wiki, add a top-level bullet under check-gh-pages-version,yml explaning the addition of the KeepAlive Workflow action
[ ] Test by running .github/workflows/check-gh-pages-version.yml and verify that the appropriate issues were created
[ ] Restore the original secret in both workflows
[ ] Create a PR in https://github.com/danielridgebot/check-ghpages-versions. Put this issue in "Questions/In Review" and apply the label "ready for dev lead".

Resources/Instructions

check-gh-pages-version.yml Keep Alive Workflow How To Use section of the Keep-Alive Workflow documentation

This issue was created from #5644

roslynwythe commented 9 months ago

@ExperimentsInHonesty this issue requires the dev to edit workflows and to view and possibly update repository settings for check-ghpages-versions. How should we instruct the assignee to request that permission?

ExperimentsInHonesty commented 9 months ago

The next steps for this, are

go read the wiki https://github.com/hackforla/ops/wiki/@danielridgebot-Ops-Wiki
submit a pr to https://github.com/danielridgebot/check-ghpages-versions
ask RW to approve.
reminder for RW, the daniel ridge bot account login is in 1password

ExperimentsInHonesty commented 8 months ago

@roslynwythe We should make sure that the documentation https://github.com/hackforla/ops/wiki/@danielridgebot-Ops-Wiki for the bot gets updated with the details of this workflow. Is that part of this issue, or should it be a follow-up issue?

ExperimentsInHonesty commented 8 months ago

@roslynwythe please add action item for whatever documenation will be necessary to add to https://github.com/hackforla/ops/wiki/@danielridgebot-Ops-Wiki

roslynwythe commented 8 months ago

@roslynwythe please add action item for whatever documenation will be necessary to add to https://github.com/hackforla/ops/wiki/@danielridgebot-Ops-Wiki

Good point. I edited the issue to add this:

[ ] On the wiki page https://github.com/hackforla/ops/wiki/@danielridgebot-Ops-Wiki, add a top-level bullet under check-gh-pages-version,yml explaning the addition of the KeepAlive Workflow action

github-actions[bot] commented 7 months ago

Hi @MarcosG119, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:- i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?) ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

MarcosG119 commented 7 months ago

Availability:

Monday-Friday 2pm-8pm
Saturday & Sunday 12pm-6pm

ETA:

Hopefully by EOD March 30th.

MarcosG119 commented 7 months ago

Getting really busy with interviews and preparation along with working; don't currently have time to finish so I am unassigning myself and returning this back to prioritized backlog.

github-actions[bot] commented 7 months ago

Hi @MarcosG119, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:- i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?) ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

MarcosG119 commented 7 months ago

Availability:

4/16 12pm - 6pm
4/17 10am - 6pm
4/18 10am - 6pm
4/19 10am - 6pm

ETA:

EOD 4/19

MarcosG119 commented 7 months ago

@roslynwythe I came across some time and completed the issue. I've also submitted the pull request but it is in the DanielRidgeBot Repo.

roslynwythe commented 6 months ago

Thank you @MarcosG119 for taking on this important issue. I don't have rights to merge PRs into that repo so I have posted a message in #ops requesting review/merge.

ExperimentsInHonesty commented 6 months ago

@MarcosG119 @gaylem is going to review the PR.

danielridgebot commented 6 months ago

Hey @roslynwythe, this is @gaylem.

When we first discussed this issue, I remember you saying that we had to generate the new Docker image and test the deployment at Dockerhub. That part doesn't seem to be in the issue scope, and based on the docs, it sounds like generating the Docker image is a separate, manual process. The workflows @MarcosG119 updated are built to generate issues that say "GHPAGES-DOCKER needs to be updated" and need to be picked up by a developer.

We were able to verify that the issues were generated when the workflow ran after the KeepAlive changes were made:

I've approved the issue. I think now, all that we need to do is merge the changes and re-enable and re-run the workflow. Everything ran successfully in testing, so I don't think there will be any issues, but this is one of those situations where we won't be positive until it runs for a while in production.

UPDATE: Ran into a token error in production while trying to run the existing workflow, so we may need to figure that out before merging.

roslynwythe commented 6 months ago

@gaylem Yes you are correct regarding the scope of the issue. Bonnie advised that there may be no one available from ops to folllow up on the "GHPAGES-DOCKER needs to be updated" issues; if you are willing to do that work, she assigned you write permissions on ghpages-docker.

gaylem commented 6 months ago

@roslynwythe Ah ok that makes sense. I can take a look once we wrap this one up.

ExperimentsInHonesty commented 4 months ago

@MarcosG119 Thanks for your patience.... We are working on this issue

https://github.com/hackforla/website/issues/6979
which now has an open pr https://github.com/danielridgebot/check-ghpages-versions/pull/23

As soon as we figure that out, we will get back to you on this issue to find out if you still want to work on it.

github-actions[bot] commented 3 months ago

@MarcosG119

Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.

Progress: "What is the current status of your project? What have you completed and what is left to do?"
Blockers: "Difficulties or errors encountered."
Availability: "How much time will you have this week to work on this issue?"
ETA: "When do you expect this issue to be completed?"
Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the Questions/In Review column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

_{You are receiving this comment because your last comment was before Tuesday, July 30, 2024 at 12:05 AM PST.}

github-actions[bot] commented 3 months ago

@MarcosG119

Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' label and add the 'Status: Updated' label.

Progress: "What is the current status of your project? What have you completed and what is left to do?"
Blockers: "Difficulties or errors encountered."
Availability: "How much time will you have this week to work on this issue?"
ETA: "When do you expect this issue to be completed?"
Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the Questions/In Review column of the Project Board and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

_{You are receiving this comment because your last comment was before Tuesday, August 6, 2024 at 12:04 AM PST.}

ExperimentsInHonesty commented 1 month ago

@MarcosG119 did you see the comment that @roslynwythe left you on Slack re your PR as noted on this PR: https://github.com/danielridgebot/check-ghpages-versions/pull/21#issuecomment-2382388438

I reached out to @MarcosG119 via Slack to see if he wants to continue work on this PR. The branch needs to be merged with updates from https://github.com/danielridgebot/check-ghpages-versions/pull/23

Do you need any help, or are you no longer interested in continuing?

roslynwythe commented 1 week ago

@ExperimentsInHonesty I decide to unassign @MarcosG119 because there was a request for change made in the PR that was not completed, and he is inactive and has not responded to any messages. I updated the issue to reflect the desired change. But also I recall that you said you would like a change to the issues that are created by the Daniel Ridge bot, so they would be more descriptive and more helpful to ops engineers, and if you would like I could incorporate those changes into this issue as well.

ExperimentsInHonesty commented 1 week ago

if you would like I could incorporate those changes into this issue as well.

Please keep the issue separate https://github.com/hackforla/ops/issues/52

HackforLABot commented 1 week ago

Hi @roslynwythe, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:- i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?) ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

hackforla / website