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

chore(github): Add manual trigger for building docs #3439

Merged
merged 1 commit into from
Nov 6, 2023

Conversation

Savio-Sou
Copy link
Collaborator

Description

Problem*

Further to #3349, part of our docs are now automatically generated instead of manually written.

At times we might want the flexibility to trigger a doc build manually to e.g. gather such generated docs (in addition to building docs along Noir pre-releases), but we currently don't have the option.

Summary*

This PR adds the ability to manually run the "Build docs" action.

Additional Context

Reference: Manually running a workflow | GitHub Docs

Demo: https://github.com/noir-lang-test/noir/actions/workflows/build-docs.yml

The demo workflow failed as actions are not properly set up in the test repo, but with this PR merged we will get the same "Run workflow" button.

image

Documentation*

Check one:

  • No documentation needed.
  • Documentation included in this PR.
  • [Exceptional Case] Documentation to be submitted in a separate PR.

PR Checklist*

  • I have tested the changes locally.
  • I have formatted the changes with Prettier and/or cargo fmt on default settings.

@Savio-Sou Savio-Sou added CI documentation Improvements or additions to documentation labels Nov 6, 2023
@Savio-Sou Savio-Sou added this pull request to the merge queue Nov 6, 2023
Merged via the queue into master with commit 16e8215 Nov 6, 2023
32 checks passed
@Savio-Sou Savio-Sou deleted the ss/docs-manual-trigger branch November 6, 2023 20:40
@Savio-Sou
Copy link
Collaborator Author

Oh hmm didn't realize the action does PR-specific checks, so manually triggering it doesn't really work without further modifications on the workflow 😅

@Savio-Sou
Copy link
Collaborator Author

Stupid me, Publish Docs rather than Build docs should actually be used for manually publishing new docs.

Creating a PR to revert this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants