Skip to content

Ignore '/docs' on some GH actions, give docs its own action#10949

Merged
rusackas merged 7 commits into
apache:masterfrom
preset-io:docs-actions
Sep 18, 2020
Merged

Ignore '/docs' on some GH actions, give docs its own action#10949
rusackas merged 7 commits into
apache:masterfrom
preset-io:docs-actions

Conversation

@rusackas
Copy link
Copy Markdown
Member

SUMMARY

First time fiddling with GitHub Actions... be kind to me :)

Attempting to skip several checks for file changes within the /docs directory. Also adding a new action that lints/builds the docs, only when files in /docs are changed.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TEST PLAN

Gonna tweak a few files herein, and see how it responds.

ADDITIONAL INFORMATION

  • Has associated issue:
  • Changes UI
  • Requires DB Migration.
  • Confirm DB Migration upgrade and downgrade tested.
  • Introduces new feature or API
  • Removes existing feature or API

@rusackas rusackas changed the title ignore docs on several actions, give docs its own action Ignore '/docs' on some GH actions, give docs its own action Sep 18, 2020
Comment thread .github/workflows/prefer-typescript.yml
Comment thread docs/src/pages/404.jsx
Comment thread .github/workflows/superset-frontend.yml
Copy link
Copy Markdown
Member

@craig-rueda craig-rueda left a comment

Choose a reason for hiding this comment

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

One comment. Agree that we want TS in docs :). Otherwise LGTM

@rusackas rusackas merged commit d4f33cc into apache:master Sep 18, 2020
@rusackas rusackas deleted the docs-actions branch September 18, 2020 19:23
@nytai
Copy link
Copy Markdown
Member

nytai commented Sep 23, 2020

This change makes it so that PRs with only changes to docs/** can never pass CI since required checks won't run. See #11026. Can we configure this filter to pass instead of remaining in a pending state forever?

@rusackas
Copy link
Copy Markdown
Member Author

rusackas commented Sep 24, 2020

This change makes it so that PRs with only changes to docs/** can never pass CI since required checks won't run. See #11026. Can we configure this filter to pass instead of remaining in a pending state forever?

@nytai @craig-rueda @ktmud
Welp... from the docs, I don't see a way to effectively skip a test AND return a positive exit code/status. I'm open to ideas if anybody has them, but my current inclination is to revert that change, and return to unnecessarily burning time/electricity.

I really want it to work though, since there are surely other checks that could be bypassed in numerous PR scenarios, in order to make things faster and (probably) less flake-prone.

@nytai
Copy link
Copy Markdown
Member

nytai commented Sep 30, 2020

@rusackas The only thing I can think of is to build the file/path checking step into the actual test code. I did something like this for the fossa check a while back, https://github.com/preset-io/incubator-superset/blob/master/.github/workflows/license-check.yml#L36

@@ -1,6 +1,12 @@
name: Frontend

on: [push, pull_request]
on:
push:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

oh nice I didn't know you could do this! GH actions ftw!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

My original GA implementation actually had some path ignores, but was removed out of abundance of caution.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think the main issue is that the check cannot be conditionally run and required. We'd have to make all these checks not required and rely on reviewers/mergers to use their best judgement when merging.

auxten pushed a commit to auxten/incubator-superset that referenced this pull request Nov 20, 2020
…0949)

* ignore docs on several actions, give docs its own action

* Random doc change to see if the new action runs.

* umm... not paths-ignore, paths!

* eof fix

* enabling typescript checking on docs
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 0.38.0 First shipped in 0.38.0 labels Mar 12, 2024
qfcwell pushed a commit to qfcwell/superset that referenced this pull request May 12, 2026
…0949)

* ignore docs on several actions, give docs its own action

* Random doc change to see if the new action runs.

* umm... not paths-ignore, paths!

* eof fix

* enabling typescript checking on docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels size/M 🚢 0.38.0 First shipped in 0.38.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants