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

Feat: Build Docs Preview on PR #37

Merged
merged 23 commits into from
Jan 31, 2024
Merged

Feat: Build Docs Preview on PR #37

merged 23 commits into from
Jan 31, 2024

Conversation

RobertRosca
Copy link
Member

CI/CD changes:

  • Manually run commands mkdocs gh-deploy would run to have more control
  • docs workflow remains functionally the same
    • however instead of overwriting the gh-pages branch it removes all files, puts the new build in, restores the pr directory (containing PR previews), commits, pushes
  • Add docs-pr workflows, which:
    • docs-pr.yml - builds docs like normal, puts them in a directory ./pr/{PR_NO} in the gh-pages branch, pushes, adds comment to PR w/ link to preview page
    • docs-pr-close.yml - removes directory from gh-pages branch, updates comment

Docs changes:

  • Adds new page docs/maintenance/ci-cd.md describing ci/cd

Copy link
Contributor

github-actions bot commented Jan 30, 2024

View preview here - https://European-XFEL.github.io/environments/pr/37 (build for 585a5a9)

Preview removed on merge/PR close with 274d2b2

@RobertRosca RobertRosca self-assigned this Jan 30, 2024
@RobertRosca RobertRosca merged commit 03bbdac into main Jan 31, 2024
3 checks passed
@RobertRosca RobertRosca deleted the feat/pr-preview-docs branch January 31, 2024 06:59
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.

1 participant