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] New tool, docs/version-check #16478

Merged

Conversation

edsantiago
Copy link
Member

Intended to be run from nightly Cirrus cron job.

  1. Queries github for highest-sorting (not necessarily "latest") tag
  2. Checks that the Windows MSI exists, fails if not
  3. Cross-checks markdown files to ensure they have up-to-date links

When run interactively, it will auto-update the .md files
to show and link to the latest version. This makes it easy
for anyone to then submit an update PR.

And, it turns out that MSI is obsolete, the new thing is EXE.
Update the tutorials to reflect that.

Signed-off-by: Ed Santiago [email protected]

None

@openshift-ci openshift-ci bot added release-note-none approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Nov 10, 2022
@@ -275,6 +275,7 @@ function _run_altbuild() {
*Windows*)
make podman-remote-release-windows_amd64.zip
make podman.msi
Copy link
Member

Choose a reason for hiding this comment

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

Huh. Should we replace this with building the new EXE installer? @n1hility

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 think #15610 is what does the EXE step, and if I read that correctly it can run only on Windows. This step here is a Linux one (the full name is "Windows Cross").

So maybe the question is, should we get rid of this step completely? Those Makefile steps are too convoluted for me to grok at a glance, but ISTR that they run a few doc checks that are important.

@edsantiago
Copy link
Member Author

This is a belated followup to #13947.

As of the moment I write this, the script will fail on run because the v4.3.1 EXE file does not exist. I assume that will be fixed later today or tomorrow?

Anyhow, this step should run and pass on this PR submission because this will not run on PRs. It should then run and FAIL on the next nightly cron, but we won't know until the Github Workflow bug is fixed.

Once the EXE is built and uploaded, and this PR is merged, I would be most grateful if someone would run it manually to see if the auto-doc-updating works and is user-friendly enough.

@edsantiago
Copy link
Member Author

Confirmed: it ran and passed

version-check: we don't run on PRs

Intended to be run from nightly Cirrus cron job.

 1) Queries github for highest-sorting (not necessarily "latest") tag
 2) Checks that the Windows MSI exists, fails if not
 3) Cross-checks markdown files to ensure they have up-to-date links

When run interactively, it will auto-update the .md files
to show and link to the latest version. This makes it easy
for anyone to then submit an update PR.

And, it turns out that MSI is obsolete, the new thing is EXE.
Update the tutorials to reflect that.

Signed-off-by: Ed Santiago <[email protected]>
@edsantiago
Copy link
Member Author

v4.3.1 EXEs are now up; the script can now be tested in production.

@TomSweeneyRedHat
Copy link
Member

LGTM

@rhatdan
Copy link
Member

rhatdan commented Nov 10, 2022

/approve
/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Nov 10, 2022
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Nov 10, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: edsantiago, 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-merge-robot openshift-merge-robot merged commit 911dc94 into containers:main Nov 10, 2022
@edsantiago edsantiago deleted the docs_version_check branch November 10, 2022 19:48
@edsantiago
Copy link
Member Author

Would someone be so kind as to run this script to update the docs?

$ git checkout -b update_windows_release_links_or_whatever_you_want_to_call_it
$ docs/version-check

@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 20, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 20, 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