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

🚫 Add page frontmatter option to disable execution #1842

Merged
merged 3 commits into from
Feb 6, 2025

Conversation

agoose77
Copy link
Contributor

@agoose77 agoose77 commented Feb 6, 2025

This PR closes #1619 by adding a new skip_execution field to the page frontmatter. I don't anticipate it being a stable addition β€” we'll probably rethink at the very least where it lives when we tackle #1498 and #1373. But, let's just get something in for now.

This is page-only, and probably only temporary; in future we'll want
to fold this in as part of our execution strategies refactor
Copy link

changeset-bot bot commented Feb 6, 2025

πŸ¦‹ Changeset detected

Latest commit: b0861df

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages
Name Type
myst-frontmatter Patch
myst-cli Patch
myst-common Patch
myst-config Patch
myst-spec-ext Patch
mystmd Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Member

@rowanc1 rowanc1 left a comment

Choose a reason for hiding this comment

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

Looks awesome. Docs are great.

Haven't tested, but this looks like everything makes sense.

@agoose77
Copy link
Contributor Author

agoose77 commented Feb 6, 2025

I haven't added tests here because they'd need to be E2E, and I want to get around to that once we overhaul how execution works. Are you OK merging without tests?

I've run a test locally with three files permuting skip_execution missing, defined true, defined false, and only the skip_execution: true notebook was skipped.

@rowanc1 rowanc1 merged commit 7448083 into main Feb 6, 2025
4 checks passed
@rowanc1 rowanc1 deleted the agoose77/feat-disable-execution branch February 6, 2025 17:10
@rowanc1
Copy link
Member

rowanc1 commented Feb 6, 2025

πŸš€πŸš€

@choldgraf
Copy link
Collaborator

yesss amazing, I can finally run execution on my blog now lol

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.

Allow execution of specific notebooks to be skipped
3 participants