Skip to content

chore: Add docs build#17101

Merged
keithwillcode merged 8 commits into
mainfrom
chore/add-docs-build
Oct 15, 2024
Merged

chore: Add docs build#17101
keithwillcode merged 8 commits into
mainfrom
chore/add-docs-build

Conversation

@keithwillcode
Copy link
Copy Markdown
Contributor

What does this PR do?

Runs a build of our docs to ensure they will always properly deploy upon merge to main.

Mandatory Tasks (DO NOT REMOVE)

  • I have self-reviewed the code (A decent size PR without self-review might be rejected).
  • I have updated the developer docs in /docs if this PR makes changes that would require a documentation change. If N/A, write N/A here and check the checkbox.
  • I confirm automated tests are in place that prove my fix is effective or that my feature works.

How should this be tested?

  • Confirm the action succeeded here

@keithwillcode keithwillcode added this to the v4.6 milestone Oct 15, 2024
@graphite-app graphite-app Bot requested a review from a team October 15, 2024 02:35
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 15, 2024

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.

Details:

No release type found in pull request title "Chore/add docs build". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

@graphite-app
Copy link
Copy Markdown

graphite-app Bot commented Oct 15, 2024

Graphite Automations

"Add foundation team as reviewer" took an action on this PR • (10/15/24)

1 reviewer was added to this PR based on Keith Williams's automation.

"Add ready-for-e2e label" took an action on this PR • (10/15/24)

1 label was added to this PR based on Keith Williams's automation.

@keithwillcode keithwillcode added core area: core, team members only foundation labels Oct 15, 2024
@dosubot dosubot Bot added ci area: CI, DX, pipeline, github actions docs area: docs, documentation, cal.com/docs labels Oct 15, 2024
npm install -g mintlify
mintlify dev &
sleep 5 # Let it run for 5 seconds
kill $!
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.

This is needed because mintlify dev waits for you to close the process. Didn't find a mintlify build.

Comment thread .github/workflows/pr.yml
secrets: inherit

build-docs:
name: Production builds
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.

Left under Production builds so it lines up with all of the other builds we do

jobs:
build:
name: Web App
name: Build Web App
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.

All of the other build commands have Build at the front of the name

@keithwillcode keithwillcode changed the title Chore/add docs build chore: Add docs build Oct 15, 2024
@keithwillcode keithwillcode added the Medium priority Created by Linear-GitHub Sync label Oct 15, 2024
@keithwillcode keithwillcode self-assigned this Oct 15, 2024
@github-actions
Copy link
Copy Markdown
Contributor

E2E results are ready!

@keithwillcode keithwillcode merged commit feefa26 into main Oct 15, 2024
@keithwillcode keithwillcode deleted the chore/add-docs-build branch October 15, 2024 08:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci area: CI, DX, pipeline, github actions core area: core, team members only docs area: docs, documentation, cal.com/docs foundation Medium priority Created by Linear-GitHub Sync ready-for-e2e

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants