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.

Sign up for GitHub

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

Jump to bottom

[Feature] CI: Implemented automated build and deployment of docs to gh-pages using GitHub Actions (Fixes #7) #8

Merged
merged 3 commits into from Mar 15, 2022
Merged

[Feature] CI: Implemented automated build and deployment of docs to gh-pages using GitHub Actions (Fixes #7) #8

merged 3 commits into from Mar 15, 2022

Conversation

abhiTronix
Copy link
Owner

@abhiTronix abhiTronix commented Mar 15, 2022 •
edited

Brief Description

This PR will implement building and deploying DeFFcode docs automatically on gh-pages through GitHub Actions workflow.

Changes

  • ✨ Implement new automated Docs Building and Deployment on gh-pages through GitHub Actions workflow:
    • 👷 Added new workflow yaml docs_deployer.yml for automated docs deployment.
    • 👷 Added different jobs with ubuntu-latest environement to build matrix.
    • 👷 Added actions/checkout@v2 for repo checkout and actions/setup-python@v2 for python environment.
    • 📌 Pinned python version to 3.8 for python environment in docs building.
    • 🎨 Added GIT_TOKEN, GIT_NAME, GIT_EMAIL environment variables through secrets.
    • ➕ Added Mkdocs Material theme related python dependencies and environments.
    • ✨ Added push on master and dev branch release with published as triggers.
    • 📌 Pinned mkdocstrings==0.17.0.
  • ✨ Added new Automated Docs Versioning:
    • ⚗️ Implemented Docs versioning through mike.
    • 👷 Separate new workflow steps to handle different versions.
    • ⚡️ Added step to auto-create RELEASE_NAME environment variable from DeFFcode version file.
    • 👷 Update docs deploy workflow to support latest, release and dev builds.
    • 👷 Added automatic release version extraction from GitHub events.
  • 📝 Docs: Re-aligned text and images in README.md
  • ✨ Maintenance: Added new FUNDING.yml with ko-fi donation link.

Related Issue

#7

Context

This PR will implement of automated building of Deffcode Docs through GitHub actions Workflow which then hosted on GitHub Pages.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

@abhiTronix
📝 Docs: Re-aligned text and images in README.md
a51e5be
@abhiTronix
🚀 CI: Implemented automated deployment of docs to gh-pages using Gi…
1631330 
…tHub Actions

- ✨ Implement new automated Deployment on `gh-pages` through GitHub Actions workflow:
  - 👷 Added new workflow yaml `docs_deployer.yml` for automated docs deployment.
  - 👷 Added different jobs with ubuntu-latest environement to build matrix.
  - 👷 Added `actions/checkout@v2` for repo checkout and `actions/setup-python@v2` for python environment.
  - 📌  Pinned python version to `3.8` for python environment in docs building.
  - 🎨 Added `GIT_TOKEN`, `GIT_NAME`, `GIT_EMAIL` environment variables through secrets.
  - ➕ Added Mkdocs Material theme related python dependencies and environments.
  - ✨ Added push on `master` and `dev` branch `release` with `published` as triggers.
  - 📌 Pinned `mkdocstrings==0.17.0`.
- ✨ Added new Automated Docs Versioning:
  - ⚗️ Implemented Docs versioning through `mike`.
  - 👷 Separate new workflow steps to handle different versions.
  - ⚡️ Added step to auto-create RELEASE_NAME environment variable from DeFFcode version file.
  - 👷 Update docs deploy workflow to support `latest`, `release` and `dev` builds.
  - 👷 Added automatic release version extraction from GitHub events.

(Note: Most of this code is borrowed from https://github.com/abhiTronix/vidgear)
@abhiTronix
✨ Maintenance: Added new FUNDING.yml with ko-fi donation link.
c631ab8
@abhiTronix abhiTronix added Documentation 📑 Improvements or additions to DeFFcode documentation. Enhancement ⚡ New feature Issue/Request enhancing DeFFcode APIs. WIP 🏗️ Work in Progress labels Mar 15, 2022
@abhiTronix abhiTronix added this to the v0.2.0 milestone Mar 15, 2022
@abhiTronix abhiTronix self-assigned this Mar 15, 2022
@abhiTronix abhiTronix added this to In progress in Deffcode v0.2.0 via automation Mar 15, 2022
@abhiTronix abhiTronix changed the title [Feature] CI: Implemented automated deployment of docs to gh-pages using GitHub Actions [Feature] CI: Implemented automated build and deployment of docs to gh-pages using GitHub Actions (Fixes #7) Mar 15, 2022
@abhiTronix abhiTronix linked an issue Mar 15, 2022 that may be closed by this pull request
Enhancement: Deploy docs to GitHub Pages using GitHub Actions #7
Closed
5 tasks
@abhiTronix abhiTronix merged commit a04c026 into master Mar 15, 2022
Deffcode v0.2.0 automation moved this from In progress to Done Mar 15, 2022
@abhiTronix abhiTronix deleted the dev branch March 15, 2022 04:49
@abhiTronix abhiTronix added Solved 🥅 Final goal achieved. and removed WIP 🏗️ Work in Progress labels Mar 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@abhiTronix abhiTronix

Labels
Documentation 📑 Improvements or additions to DeFFcode documentation. Enhancement ⚡ New feature Issue/Request enhancing DeFFcode APIs. Solved 🥅 Final goal achieved.
Projects
No open projects
Deffcode v0.2.0
Done
Milestone
v0.2.0
Development

Successfully merging this pull request may close these issues.

Enhancement: Deploy docs to GitHub Pages using GitHub Actions
1 participant
@abhiTronix