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

Add deploy-docsite workflow, Add build docsite to test workflow #47

Merged
merged 4 commits into from
Jun 18, 2024

Conversation

jem-davies
Copy link
Collaborator

YOU WILL NEED TO CHANGE A SETTING

In the github repo UI:

  • click 'settings'
  • left side bar, under 'code and automation' > Click 'Pages'
  • Under heading 'Build and deployment' > dropdown 'Source' > Change to 'Github Actions'

@jem-davies jem-davies linked an issue Jun 16, 2024 that may be closed by this pull request
@jem-davies
Copy link
Collaborator Author

Changes:

  • Added a 'job' to .github/workflows/deploy-docsite.yml workflow, that will build the doc site when a PR is created.
  • Added a new .github/workflows/deploy-docsite.yml that will redeploy the site on push to main.

I have made this repo with a change to the favicon to test - link to site.

on:
workflow_dispatch:
push:
branches: [main]
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should this also happen on tag creation/release events?

Copy link
Collaborator Author

@jem-davies jem-davies Jun 18, 2024

Choose a reason for hiding this comment

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

I think that you could do either: on pushes to main OR a release event, I think if you did both you would be rebuilding the same site on a release event.

If we decide to only re-build the docsite on release then we can still trigger the build manually in the github UI for small fixes, i.e. favicon changes.

@richardartoul what do you reckon?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yeah sure I see what you're saying. Perhaps just on main is fine since calling go install with latest will return HEAD of main in any case.

jem-davies and others added 4 commits June 18, 2024 17:37
Signed-off-by: Jem Davies <jemsot@gmail.com>
Signed-off-by: Jem Davies <jemsot@gmail.com>
Signed-off-by: Jem Davies <jemsot@gmail.com>
Signed-off-by: Jem Davies <jemsot@gmail.com>
@jem-davies jem-davies merged commit 3f03929 into main Jun 18, 2024
3 checks passed
@jem-davies jem-davies deleted the 45-website-not-redeployed branch June 18, 2024 15:43
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.

website not redeployed
2 participants