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 github action #1

Open
kristinmarshall-NOAA opened this issue Jun 6, 2022 · 1 comment
Open

Add github action #1

kristinmarshall-NOAA opened this issue Jun 6, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@kristinmarshall-NOAA
Copy link
Contributor

@kellijohnson-NOAA suggested it would be a good idea to add a github action that compiles the document automatically so users don't have to download all the code and compile it themselves, and/or we don't have to regularly post a compiled version

@iantaylor-NOAA iantaylor-NOAA added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 17, 2023
@iantaylor-NOAA
Copy link

iantaylor-NOAA commented Feb 17, 2023

@kristinmarshall-NOAA, revisiting this based on our discussion a few minutes ago, I think that all that's needed to get the quarto doc compiling and posted to github for public access are to run these commands:

install.packages("remotes") # probably you already have this
remotes::install_github("nmfs-fish-tools/ghactions4r") # install package maintained by Kathryn Doering
ghactions4r::use_build_deploy_bookdown()

Those commands create the .yml files that github will use to run the github action and push the document to the github site.
You may also have to change the settings to tell it to deploy the pages from a "gh-actions" branch which hasn't yet been created (but will be by the github action). See screenshot below. You can look at this site for example settings (which you should have access to): https://github.com/pfmc-assessments/pfmc_assessment_handbook/settings/pages.

I'm happy to work on this, but if you want to see how the setup process works, please go for it.

Settings page that maybe needs changing (or at least looking at), once the github action runs and creates the "gh-actions" branch:
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants