Skip to content

Rework Update workflows and remove master docs - #1263

Merged
iethree merged 2 commits into
masterfrom
dont-allow-pulling-master
Jul 30, 2026
Merged

Rework Update workflows and remove master docs#1263
iethree merged 2 commits into
masterfrom
dont-allow-pulling-master

Conversation

@iethree

@iethree iethree commented Jul 30, 2026

Copy link
Copy Markdown
Contributor
  1. Removes the master branch docs, which should never be committed or published
  2. .gitignores the master branch docs dir, so they cannot be committed
  3. Reworks the update docs workflow
    a. There's only one workflow now, instead of 3
    b. It runs nightly on a cron with a configured LATEST_VERSION
    c. It can be run manually and takes a single major version argument, rather than two branch names.

See discussion thread: https://metaboat.slack.com/archives/C0ACAG2CXHV/p1785433663417059

Best to review the second commit which is much smaller and contains all the workflow changes 66da972

iethree added 2 commits July 30, 2026 13:06
these should have been omitted, they mess up SEO and have been intentionally removed a few times
@iethree
iethree requested review from a team, alexyarosh and jeff-bruemmer July 30, 2026 19:45
@iethree iethree changed the title Rework Update4 workflows Rework Update workflows and remove master docs Jul 30, 2026

@gantoreno gantoreno left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nice! One non-blocking thing but probably worth knowing is that the clojure script still categorizes master as a publishable artifact

[category
release-num] (u/categorize-branchname target-branch)
command (-> (cond
(= category :master)
"./script/docs master --set-version master"

And it even tests for it

(def ^:private branches ["master"
"release-x.49.x"
"release-x.50.x"
;; Current release branch:
(str "release-x." (u/config-docs-version) ".x")
"any-other-branch"])
(def ^:private source-branch-name "my-new-docs-branch")
(def ^:private expected
(assoc {"master" {:publish-branch-docs? true
:update-docs-command (str "./script/docs master --set-version master --source-branch " source-branch-name)}
"release-x.49.x" {:publish-branch-docs? true
:update-docs-command (str "./script/docs release-x.49.x --set-version v0.49 --source-branch " source-branch-name)}
"release-x.50.x" {:publish-branch-docs? true
:update-docs-command (str "./script/docs release-x.50.x --set-version v0.50 --source-branch " source-branch-name)}
"any-other-branch" {:publish-branch-docs? false
:update-docs-command "Unpublishable branchname"}}

For correctness, going forward it might be a good idea to invert that assertion

description: 'Major version to pull docs from metabase/metabase release branch'
required: true
type: number
default: 999

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Does this need a default? Is it required?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

i think it's helpful to demonstrate the format (99 vs v99 vs release-x.99.x)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

clojure script still categorizes master as a publishable artifact

I want clojure outta this repo in the medium term, but I'm gonna let @bpander do that as part of rationalizing the build process. I don't want to spend too much time tightening up a script that we plan to delete

@alexyarosh alexyarosh left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Ryan you are my favorite person

@iethree
iethree merged commit 35b83dc into master Jul 30, 2026
1 check passed
@iethree
iethree deleted the dont-allow-pulling-master branch July 30, 2026 20:01
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.

4 participants