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

Issue 26: Create CI for GitHub pages website #31

Merged
merged 6 commits into from
May 15, 2024
Merged

Issue 26: Create CI for GitHub pages website #31

merged 6 commits into from
May 15, 2024

Conversation

athowes
Copy link
Collaborator

@athowes athowes commented May 14, 2024

Description

This PR will close #26.

I have run usethis::use_pkgdown_github_pages(). I get the error

Error in `gh::gh()`:
! GitHub API error (404): Not Found
✖ URL not found: <https://api.github.com/repos/epinowcast/epidist>
ℹ Read more at <https://docs.github.com/rest/repos/repos#update-a-repository>
Run `rlang::last_trace()` to see where the error occurred.

which I'm currently trying to fix (though could be a permission thing?).

Checklist

  • My PR is based on a package issue and I have explicitly linked it.
  • I have included the target issue or issues in the PR title in the for Issue(s) issue-numbers: PR title
  • I have read the contribution guidelines.
  • I have tested my changes locally.
  • I have added or updated unit tests where necessary.
  • I have updated the documentation if required.
  • My code follows the established coding standards.
  • I have added a news item linked to this PR.
  • I have reviewed CI checks for this PR and addressed them as far as I am able.

@athowes athowes changed the title Create CI for GitHub pages website Issue 26: Create CI for GitHub pages website May 14, 2024
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main]
Copy link
Contributor

Choose a reason for hiding this comment

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

we don't want the master stuff here

@@ -42,7 +49,7 @@ jobs:

- name: Deploy to GitHub pages 🚀
if: github.event_name != 'pull_request'
uses: JamesIves/github-pages-deploy-action@v4.6.0
uses: JamesIves/github-pages-deploy-action@v4.5.0
Copy link
Contributor

Choose a reason for hiding this comment

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

why role this back?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I don't know. I used usethis::use_pkgdown_github_pages() and it automatically made these changes. Happy to revert this back forward.

Copy link
Contributor

Choose a reason for hiding this comment

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

yes please do.

@athowes
Copy link
Collaborator Author

athowes commented May 14, 2024

Any ideas on what I should do (/if I should be aiming) to fix my API issue @seabbs?

@seabbs
Copy link
Contributor

seabbs commented May 14, 2024

The build failure shows the issue with the current pkgdown deployment: https://github.com/epinowcast/epidist/actions/runs/9076507452/job/24939351635?pr=31#step:7:1

It looks like it is due to the enwtheme not being available which relates to your issue about it not having clear usage instructions. The fix is to use the approach that epinowcast takes (having it in the DESCRIPTION as part of the website dependencies but this also suggests that a small prr to enwtheme would really help others in the future.

@athowes
Copy link
Collaborator Author

athowes commented May 14, 2024

I believe I have fixed these three issues (version, remove master, add theme dependency [I also added pkgdown, as listed on epinowcast DESCRIPTION]).

@athowes
Copy link
Collaborator Author

athowes commented May 15, 2024

The build failed this time due to no bookdown package available: https://github.com/epinowcast/epidist/actions/runs/9084323528/job/24965006900?pr=31

I have added this package to Suggests. It would be nice if there were a way I could test this without fixing where it fails one by one using checks. Let me know if there is a better way I can do it.

@athowes
Copy link
Collaborator Author

athowes commented May 15, 2024

This passed now, so perhaps can be reviewed / merged @seabbs.

@seabbs seabbs self-requested a review May 15, 2024 09:37
Copy link
Contributor

@seabbs seabbs left a comment

Choose a reason for hiding this comment

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

Lgtm. Nice one! Note we should start tracking issue resolution in the news file (see the pr checklist and epinowcast)

@seabbs seabbs enabled auto-merge May 15, 2024 09:39
@seabbs seabbs merged commit 6930bfe into main May 15, 2024
4 checks passed
@seabbs seabbs deleted the website-ci branch May 15, 2024 09:40
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.

Make pkgdown CI to auto-build and deploy website
2 participants