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

Update deploy_docc.yml #18

Merged
merged 2 commits into from
May 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@ All notable changes to this project will be documented in this file.
- Added in Pull Request [#7](https://github.com/space-code/package-template/pull/7).

## Updated
- Update `post_get_project` script
- Updated in Pull Request[#14](https://github.com/space-code/package-template/pull/14).
- Update the `deploy_docc.yml` action
- Updated in Pull Request [#18](https://github.com/space-code/package-template/pull/18).
- Update the `post_get_project` script
- Updated in Pull Request [#14](https://github.com/space-code/package-template/pull/14).

#### 1.x Releases
- `1.1.x` Releases - [1.1.0](#110) | [1.1.1](#111)
Expand Down
4 changes: 4 additions & 0 deletions cookiecutter.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,9 @@
"deploy_docc": [
"Yes",
"No"
],
"docc_custom_branch": [
"Yes",
"No"
]
}
18 changes: 15 additions & 3 deletions {{ cookiecutter.name | lower }}/.github/workflows/deploy_docc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,16 @@ jobs:
deploy:
environment:
name: github-pages
{% raw %}
{% raw -%}
url: ${{ steps.deployment.outputs.page_url }}
{% endraw %}
{% endraw -%}
runs-on: macos-12
steps:
- name: Checkout 🛎️
uses: actions/checkout@v3
# Fetch all history for all branches and tags.
fetch-depth: 0
{% if cookiecutter.docc_custom_branch == "No" -%}
- name: Build DocC
run: |
swift build;
Expand All @@ -41,4 +44,13 @@ jobs:
path: 'docs'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
uses: actions/deploy-pages@v1
{% endif -%}
{% if cookiecutter.docc_custom_branch == "Yes" -%}
- name: Build and Push Generated Documentation
uses: space-code/oss-common-actions/.github/actions/publish_docc@main
with:
target: {{ cookiecutter.name }}
output_path: ./docs
hosting_base_path: {{ cookiecutter.name | lower }}
{% endif -%}
Loading