https://github.com/kiarashvosough1999/docc-github-pages-deploy

Deploy Generated DocC Static Site To Github-Pages.
https://github.com/kiarashvosough1999/docc-github-pages-deploy

docc documentation github-pages githubpages ios macos spm static-site swift

Last synced: 3 months ago
JSON representation

Deploy Generated DocC Static Site To Github-Pages.

• Host: GitHub
• URL: https://github.com/kiarashvosough1999/docc-github-pages-deploy
• Owner: kiarashvosough1999
• License: mit
• Created: 2022-09-22T07:46:18.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-09-22T11:42:48.000Z (over 2 years ago)
• Last Synced: 2024-12-01T13:02:09.010Z (3 months ago)
• Topics: docc, documentation, github-pages, githubpages, ios, macos, spm, static-site, swift
• Homepage:
• Size: 16.6 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Twitter](https://img.shields.io/badge/Twitter-@Vosough_k-blue.svg?style=flat-square)](https://twitter.com/vosough_k)

[![Linkedin](https://img.shields.io/badge/Linkedin-KiarashVosough-blue.svg?style=flat-square)](https://www.linkedin.com/in/kiarashvosough/)

DocC Github Pages Deploy: Deploy Generated DocC Static Site To Github-Pages.

- [Requirements](#requirements)

- [Usage](#usage)

- [Integration](#integration-with-build-docC-static-site)

- [Contributors](#contributors)

- [License](#license)

## Requirements

| Platform  | Status |

| --- | --- |

|  ubuntu-latest | Tested |

## Usage

See [action.yml](https://github.com/kiarashvosough1999/docC-github-pages-deploy/blob/master/action.yml).

> Make sure to set the version to latest tag.

As An Example:

```yml

name: worksapce

on:

  push:

    branches:

      - '**'

jobs:

  build_deploy_site:

    runs-on: ubuntu-latest

    environment:

      name: github-pages

      url: ${{ steps.deployment.outputs.page_url }}

    permissions:

      pages: write

      contents: read

      id-token: write

    steps:

    - name: deploy static site

      uses: kiarashvosough1999/[email protected]

```

> Make Sure give access to `pages`, `contents` and `id-token`, or the action will fail to push the site into Github-Pages.

> Make sure to specify the `name` and `url` on the environment like the example, or the job will fail.

## Integration With Build DocC Static Site

You can use [build-docC-static-site](https://github.com/kiarashvosough1999/build-docC-static-site/tree/master) to generate static site from DocC Archive.

> The default `docC-generated-static-site-uploaded-name` associated with [build-docC-static-site

](https://github.com/kiarashvosough1999/build-docC-static-site/tree/master) and `docC-generated-static-site-zipped-upload-name` associated with this action, input must be the same.

> This action will unzip the input static site with `gtar` and `tar` extension. So do not specify the zip extension on either `docC-generated-static-site-uploaded-name` or `docC-generated-static-site-zipped-upload-name`.

 

## Contributors

Feel free to share your ideas or any other problems. Pull requests are welcomed.

## License

docC-github-pages-deploy is released under an MIT license. See [LICENSE](https://github.com/kiarashvosough1999/build-docC-static-site/blob/master/LICENSE) for more information.