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

[CI:DOCS] Fix docs/version-check always requesting updates #17620

Merged

Conversation

cevich
Copy link
Member

@cevich cevich commented Feb 23, 2023

DEPENDS ON: #17621

As suggested by @edsantiago, the complex script and direct-link in the
docs are adding little value while increasing the CI maintenance burden.
Simply retire the script and strip the direct (versioned) links from the
docs.


Fixes (in cirrus-cron CI), this message always appearing & job failing:

+ docs/version-check
LATEST=v4.4.1
version-check: docs/tutorials/mac_win_client.md: needs updating.
version-check: Please run this script in an interactive shell, and I'll fix it.
version-check: docs/tutorials/podman-for-windows.md: needs updating.
version-check: Please run this script in an interactive shell, and I'll fix it.

Does this PR introduce a user-facing change?

None

@cevich cevich requested a review from edsantiago February 23, 2023 19:50
@openshift-ci openshift-ci bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. release-note-none labels Feb 23, 2023
@cevich
Copy link
Member Author

cevich commented Feb 23, 2023

@edsantiago PTAL when you have time, this is not critical but it is causing the daily cirrus-cron job on main to "fail". I'll open another PR to disable the version-check for now until we're able to work out a fix (this PR or otherwise).

@cevich
Copy link
Member Author

cevich commented Feb 23, 2023

Force-push: Rebased on #17621 + added revert.

@cevich cevich force-pushed the disable_version_check branch from 7d2c60d to 79f391b Compare February 23, 2023 19:58
@cevich
Copy link
Member Author

cevich commented Feb 23, 2023

force-push: Fixed missing DCO

@cevich cevich changed the title [WIP] [CI:DOCS] Fix docs/version-check always requesting updates [CI:DOCS] Fix docs/version-check always requesting updates Feb 23, 2023
@cevich cevich marked this pull request as ready for review February 23, 2023 20:04
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 23, 2023
@cevich
Copy link
Member Author

cevich commented Feb 23, 2023

/hold waiting-for-ed

@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Feb 23, 2023
@edsantiago
Copy link
Member

I'm going to defer this. It's impossible to review today, because there's a release in progress: tag without build.

version-check: FATAL: Windows EXE missing: https://github.com/containers/podman/releases/download/v4.4.2/podman-4.4.2-setup.exe

And grep -o is not an option I've ever used, so I'd like to get super-familiar with it before approving this. That won't happen today.

I'm totally fine with just removing this step. I don't know if it really adds any value.

@cevich
Copy link
Member Author

cevich commented Feb 27, 2023

I'm totally fine with just removing this step. I don't know if it really adds any value.

In fact, now that I've thought about it, this is likely the case. Not too long ago I updated the Makefile to rename the Windows installer file w/o a version number. So I think this script can just be removed, and the docs updated to point at the Downloads page (where the unversioned Windows binary link should be maintained).

@cevich
Copy link
Member Author

cevich commented Feb 27, 2023

Correction: These markdown pages are about the released Windows installer, not the CI artifact. Still, I think Ed's right, including the version number and a direct link adds little value and a whole lot of (script) complications. Let's just remove it and the generic "release page" link is very likely good enough.

@cevich cevich force-pushed the disable_version_check branch from 79f391b to 991c7e6 Compare February 27, 2023 16:29
@cevich
Copy link
Member Author

cevich commented Feb 27, 2023

Force-push: Remove the script and update docs pages accordingly.

As suggested by @edsantiago, the complex script and direct-link in the
docs are adding little value while increasing the CI maintenance burden.
Simply retire the script and strip the direct (versioned) links from the
docs.

Signed-off-by: Chris Evich <[email protected]>
@cevich cevich force-pushed the disable_version_check branch from f8543c0 to 0d21948 Compare March 2, 2023 19:18
@cevich
Copy link
Member Author

cevich commented Mar 2, 2023

Force-push: Rebased and squashed.

@TomSweeneyRedHat
Copy link
Member

LGTM
and happy green test buttons

@rhatdan
Copy link
Member

rhatdan commented Mar 3, 2023

/approve
/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Mar 3, 2023
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Mar 3, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cevich, rhatdan

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 3, 2023
@rhatdan
Copy link
Member

rhatdan commented Mar 3, 2023

/hold cancel

@openshift-ci openshift-ci bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 3, 2023
@openshift-merge-robot openshift-merge-robot merged commit d4b2215 into containers:main Mar 3, 2023
@github-actions github-actions bot added the locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. label Sep 7, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 7, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. release-note-none
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants