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

GitHub Actions to build and deploy docc documentations #69

Merged
merged 15 commits into from
Oct 5, 2023

Conversation

rizwankce
Copy link
Contributor

What it Does

How I Tested

  • I have created the same steps on my fork and made GitHub page deployment

Notes

  • Please take a look at the documentation hosted in my fork - link for example
  • To make it work for this repo . all we have to do is enable GitHub Actions on Pages settings. like below

image

@rizwankce rizwankce changed the title Ci build and deploy docc GitHub Actions to build and deploy docc documentations Oct 4, 2023
- name: Checkout Repository
uses: actions/checkout@v4
with:
fetch-depth: 0
Copy link

Choose a reason for hiding this comment

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

This could also be 1 as you do not need the whole history

Copy link
Owner

Choose a reason for hiding this comment

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

What does this do? I haven't looked at it in-depth yet

Copy link
Contributor Author

Choose a reason for hiding this comment

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

0 would get all the git history, brackens and tags. Default is 1 where it will fetch only the intended branch.

@@ -0,0 +1,15 @@
##!/bin/sh

xcrun xcodebuild docbuild \
Copy link

Choose a reason for hiding this comment

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

might be nice to move this into a subfolder like tools so tat it is "hidden" for those who don't need to know about it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

How about folder named scripts?

Copy link
Owner

Choose a reason for hiding this comment

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

I think .scripts would work (so it's a hidden folder by default

Copy link
Owner

@mikaelacaron mikaelacaron left a comment

Choose a reason for hiding this comment

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

Great work!! I'm so excited for this!

Basic-Car-Maintenance.xcodeproj/project.pbxproj Outdated Show resolved Hide resolved
Basic-Car-Maintenance.xcodeproj/project.pbxproj Outdated Show resolved Hide resolved
Basic-Car-Maintenance.xcodeproj/project.pbxproj Outdated Show resolved Hide resolved
Basic-Car-Maintenance.xcodeproj/project.pbxproj Outdated Show resolved Hide resolved
@mikaelacaron mikaelacaron merged commit 38b0b74 into mikaelacaron:dev Oct 5, 2023
@mikaelacaron
Copy link
Owner

It's alive!! Great work!!

It took about 5 minutes to run, is that normal?

https://mikaelacaron.github.io/Basic-Car-Maintenance/documentation/basic-car-maintenance/documentation

@rizwankce
Copy link
Contributor Author

@mikaelacaron Finally good to see it in live!

I just saw the build details and majority of the time taken for fetching swift packages. Best way to save time would be caching the swift packages. Let me work on improving the build time for docc GitHub action.

@mikaelacaron
Copy link
Owner

Let me work on improving the build time for docc GitHub action.

Can you create a new issue for this? and I can assign it to you! Thanks!

@rizwankce
Copy link
Contributor Author

@mikaelacaron created #81 to track.

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.

GitHub Action for Creating DocC Documentation
3 participants