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

Setup GitHub Actions to re-render README #16

Open
judith-bourque opened this issue Dec 27, 2022 · 4 comments · Fixed by #18, #19, #20, #21 or #22
Open

Setup GitHub Actions to re-render README #16

judith-bourque opened this issue Dec 27, 2022 · 4 comments · Fixed by #18, #19, #20, #21 or #22
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@judith-bourque
Copy link
Owner

judith-bourque commented Dec 27, 2022

Issue

README.Rmd doesn't re-knit automatically to README.md.

Proposed solution

Setup GitHub Actions to re-render README.Rmd every time you push. An example workflow can be found here: https://github.com/r-lib/actions/tree/v1/examples.

See also:

@judith-bourque judith-bourque added the documentation Improvements or additions to documentation label Dec 27, 2022
@judith-bourque judith-bourque self-assigned this Dec 28, 2022
@judith-bourque
Copy link
Owner Author

judith-bourque commented Dec 28, 2022

Issue

R-CMD-check badge won't display properly in README.

Possible solution

clessn/clessnverse#45 (comment)

@judith-bourque
Copy link
Owner Author

judith-bourque commented Dec 28, 2022

Issue

R-CMD-check badge won't display properly in README.

Possible solution

clessn/clessnverse#45 (comment)

Doesn't seem to solve issue.

Pushed the branch to main and the action ran properly and badge now displays properly.

@judith-bourque judith-bourque linked a pull request Dec 28, 2022 that will close this issue
@judith-bourque judith-bourque linked a pull request Dec 28, 2022 that will close this issue
@judith-bourque
Copy link
Owner Author

judith-bourque commented Dec 29, 2022

Issue

render-markdown.yaml failed, see error message in commit.

Possible solution

  • Specify GitHub token in environment
  • See GitHub Actions syntax

GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}

@judith-bourque judith-bourque added the help wanted Extra attention is needed label Dec 29, 2022
@judith-bourque
Copy link
Owner Author

Can't add secret with GITHUB prefix.

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 help wanted Extra attention is needed
Projects
None yet
1 participant