Skip to content

Commit 19bd70d

Browse files
committed
Merged with latest release of official RMarkdown.
Merge remote-tracking branch 'rstudio_origin/master' into jg-devel * rstudio_origin/master: (26 commits) Use data-external=1 to prevent encoding by Pandoc of img src add `subdirs` documentation for site generator (rstudio#2058) fix: corrected typo in `ghostscript` (rstudio#2059) Add CoC contact email quillt has moved to rstudio/quillt fix invalid HTML code in shiny_prerendered documents (rstudio#1942) Allow pkgdown PR preview (rstudio#2055) Adding pkgdown site built by GHA (rstudio#1955) Add shiny bslib dependency inside html_document_base pre-process (rstudio#2049) start the next version CRAN release v2.7 place <div> in \code{} amend 62ae2ed and rstudio#1989: make sure output_format_filter is a function; testing NULL is not enough, e.g., the radix package still calls use CRAN releases of shiny and bslib tweak news Only keep the first url in citation (rstudio#2041) Fix for knit_print.data.frame (rstudio#2050) set gfm_auto_identifiers to input format if toc is TRUE (rstudio#2040) Enable pkgdown/downlit cross-package links to rmarkdown (rstudio#1843) update CONTRIBUTING.md ... # Conflicts: # DESCRIPTION
2 parents 77961f8 + c0b8584 commit 19bd70d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+552
-273
lines changed

.Rbuildignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,6 @@
1212
^doc$
1313
^Meta$
1414
^codecov\.yml$
15+
^docs$
16+
^reference$
17+
^vignettes/articles$

.github/CODE_OF_CONDUCT.md

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards
42+
of acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies
54+
when an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail
56+
address, posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at codeofconduct@rstudio.com. All complaints will be reviewed and investigated promptly and fairly.
63+
64+
All community leaders are obligated to respect the privacy and security of the
65+
reporter of any incident.
66+
67+
## Enforcement Guidelines
68+
69+
Community leaders will follow these Community Impact Guidelines in determining
70+
the consequences for any action they deem in violation of this Code of Conduct:
71+
72+
### 1. Correction
73+
74+
**Community Impact**: Use of inappropriate language or other behavior deemed
75+
unprofessional or unwelcome in the community.
76+
77+
**Consequence**: A private, written warning from community leaders, providing
78+
clarity around the nature of the violation and an explanation of why the
79+
behavior was inappropriate. A public apology may be requested.
80+
81+
### 2. Warning
82+
83+
**Community Impact**: A violation through a single incident or series of
84+
actions.
85+
86+
**Consequence**: A warning with consequences for continued behavior. No
87+
interaction with the people involved, including unsolicited interaction with
88+
those enforcing the Code of Conduct, for a specified period of time. This
89+
includes avoiding interactions in community spaces as well as external channels
90+
like social media. Violating these terms may lead to a temporary or permanent
91+
ban.
92+
93+
### 3. Temporary Ban
94+
95+
**Community Impact**: A serious violation of community standards, including
96+
sustained inappropriate behavior.
97+
98+
**Consequence**: A temporary ban from any sort of interaction or public
99+
communication with the community for a specified period of time. No public or
100+
private interaction with the people involved, including unsolicited interaction
101+
with those enforcing the Code of Conduct, is allowed during this period.
102+
Violating these terms may lead to a permanent ban.
103+
104+
### 4. Permanent Ban
105+
106+
**Community Impact**: Demonstrating a pattern of violation of community
107+
standards, including sustained inappropriate behavior, harassment of an
108+
individual, or aggression toward or disparagement of classes of individuals.
109+
110+
**Consequence**: A permanent ban from any sort of public interaction within the
111+
community.
112+
113+
## Attribution
114+
115+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
116+
version 2.0,
117+
available at <https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
118+
119+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
120+
enforcement ladder](https://github.com/mozilla/diversity).
121+
122+
[homepage]: https://www.contributor-covenant.org
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
<https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.

.github/CONTRIBUTING.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
1-
We welcome contributions to the **rmarkdown** package. To submit a contribution:
1+
# Contributing to R Markdown
22

3-
1. [Fork](https://github.com/rstudio/rmarkdown/fork) the repository and make your changes.
3+
We welcome contributions to the **rmarkdown** package.
44

5-
2. Ensure that you have signed the [individual](https://rstudioblog.files.wordpress.com/2017/05/rstudio_individual_contributor_agreement.pdf) or [corporate](https://rstudioblog.files.wordpress.com/2017/05/rstudio_corporate_contributor_agreement.pdf) contributor agreement as appropriate. You can send the signed copy to <jj@rstudio.com>.
5+
You can contribute in many ways:
66

7-
3. Submit a [pull request](https://help.github.com/articles/using-pull-requests).
7+
* By opening issues to five feedback and share ideas.
8+
* By fixing typos in documentations
9+
* By submitting Pull Request (PR) to fix some opened issues
10+
* By submitting Pull Request (PR) to suggest some new features. (It is considered good practice to open issues before to discuss ideas)
11+
12+
## To submit a contribution using a Pull Request:
13+
14+
1. [Fork](https://github.com/rstudio/rmarkdown/fork) the repository and make your changes in a new branch specific to the PR.
15+
16+
2. For significant changes (e.g not required for fixing typos), ensure that you have signed the [individual](https://rstudioblog.files.wordpress.com/2017/05/rstudio_individual_contributor_agreement.pdf) or [corporate](https://rstudioblog.files.wordpress.com/2017/05/rstudio_corporate_contributor_agreement.pdf) contributor agreement as appropriate. You can send the signed copy to <jj@rstudio.com>.
17+
18+
3. Submit the [pull request](https://help.github.com/articles/using-pull-requests). It is ok to submit as draft in your are still working on it but would like some feedback from us. It always good to share in the open that you are working on it.
819

920
We'll try to be as responsive as possible in reviewing and accepting pull requests. Appreciate your contributions very much!

.github/workflows/R-CMD-check.yaml

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,16 @@ on:
55
branches:
66
- main
77
- master
8+
paths-ignore:
9+
- 'pkgdown/**'
10+
- '.github/workflows/pkgdown.yaml'
811
pull_request:
912
branches:
1013
- main
1114
- master
15+
paths-ignore:
16+
- 'pkgdown/**'
17+
- '.github/workflows/pkgdown.yaml'
1218

1319
name: R-CMD-check
1420

@@ -24,7 +30,7 @@ jobs:
2430
- {os: windows-latest, pandoc: '2.7.3', r: 'release'}
2531
- {os: macOS-latest, pandoc: '2.7.3', r: 'release'}
2632
- {os: ubuntu-18.04, pandoc: '2.7.3', r: 'oldrel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
27-
- {os: ubuntu-18.04, pandoc: '2.7.3', r: 'devel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
33+
- {os: ubuntu-18.04, pandoc: '2.7.3', r: 'devel', rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest", http-user-agent: "R/4.0.0 (ubuntu-16.04) R (4.0.0 x86_64-pc-linux-gnu x86_64 linux-gnu) on GitHub Actions" }
2834
- {os: ubuntu-18.04, pandoc: '2.7.3', r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
2935
- {os: ubuntu-18.04, pandoc: '2.11.3.1', r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
3036
- {os: ubuntu-18.04, pandoc: 'devel', r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"}
@@ -38,8 +44,15 @@ jobs:
3844
- uses: actions/checkout@v2
3945

4046
- uses: r-lib/actions/setup-r@v1
47+
id: install-r
4148
with:
4249
r-version: ${{ matrix.config.r }}
50+
http-user-agent: ${{ matrix.config.http-user-agent }}
51+
52+
- name: change temp dir
53+
if: runner.os == 'Windows'
54+
run: echo "TMPDIR=${{ runner.temp }}" >> $GITHUB_ENV
55+
shell: bash
4356

4457
- uses: r-lib/actions/setup-pandoc@v1
4558
if: matrix.config.pandoc != 'devel'
@@ -49,51 +62,44 @@ jobs:
4962
- uses: cderv/actions/setup-pandoc-nightly@nightly-pandoc
5063
if: matrix.config.pandoc == 'devel'
5164

52-
# TODO: Use next tag once this commit is in a release
53-
- uses: r-lib/actions/setup-tinytex@5f1c134
65+
- uses: r-lib/actions/setup-tinytex@v1
5466
env:
5567
# install full prebuilt version
56-
TINYTEX_INSTALLER: TinyTeX-1
68+
TINYTEX_INSTALLER: TinyTeX
5769

5870
- name: Add some R options for later steps
5971
run: |
6072
cat("\noptions(tinytex.verbose = TRUE)\n", file = "~/.Rprofile", append = TRUE)
6173
cat(readLines("~/.Rprofile"), sep = "\n")
6274
shell: Rscript {0}
6375

64-
- name: Query dependencies
76+
- name: Install pak and query dependencies
6577
run: |
66-
install.packages('remotes')
67-
saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
68-
writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
78+
install.packages("pak", repos = "https://r-lib.github.io/p/pak/dev/")
79+
saveRDS(pak::pkg_deps_tree("local::.", dependencies = TRUE), ".github/r-depends.rds")
6980
shell: Rscript {0}
7081

7182
- name: Cache R packages
7283
uses: actions/cache@v2
7384
with:
7485
path: ${{ env.R_LIBS_USER }}
75-
key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}
76-
restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-
86+
key: ${{ runner.os }}-${{ steps.install-r.outputs.installed-r-version }}-1-${{ hashFiles('.github/r-depends.rds') }}
87+
restore-keys: ${{ runner.os }}-${{ steps.install-r.outputs.installed-r-version }}-1-
7788

7889
- name: Install system dependencies
7990
if: runner.os == 'Linux'
80-
run: |
81-
while read -r cmd
82-
do
83-
eval sudo $cmd
84-
done < <(Rscript -e 'writeLines(remotes::system_requirements("ubuntu", "18.04"))')
91+
run: Rscript -e 'pak::local_system_requirements(execute = TRUE)'
8592

8693
- name: Install dependencies
8794
run: |
88-
remotes::install_deps(dependencies = TRUE)
89-
remotes::install_cran("rcmdcheck")
90-
remotes::install_cran("sessioninfo")
95+
pak::local_install_dev_deps(upgrade = TRUE)
96+
pak::pkg_install("rcmdcheck")
9197
shell: Rscript {0}
9298

9399
- name: Session info
94100
run: |
95101
options(width = 100)
96-
pkgs <- installed.packages()[, "Package"]
102+
pkgs <- .packages(TRUE)
97103
sessioninfo::session_info(pkgs, include_base = TRUE)
98104
rmarkdown::find_pandoc()
99105
tinytex::tlmgr("--version")
@@ -104,7 +110,6 @@ jobs:
104110
env:
105111
_R_CHECK_CRAN_INCOMING_: false
106112
_R_CHECK_TESTS_NLINES_: 0
107-
TMPDIR: ${{ runner.temp }}
108113
run: rcmdcheck::rcmdcheck(args = c("--no-manual", "--as-cran"), error_on = "warning", check_dir = "check")
109114
shell: Rscript {0}
110115

@@ -123,6 +128,6 @@ jobs:
123128
- name: Test coverage
124129
if: success() && runner.os == 'Linux' && matrix.config.r == 'release' && matrix.config.pandoc == '2.7.3'
125130
run: |
126-
remotes::install_cran("covr")
131+
pak::pkg_install('covr')
127132
covr::codecov()
128133
shell: Rscript {0}

.github/workflows/pkgdown.yaml

Lines changed: 43 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,77 @@
11
on:
2-
workflow_run:
3-
workflows: ["R-CMD-check"]
4-
branches: [main,master]
5-
types: completed
2+
push:
3+
branches:
4+
- main
5+
- master
6+
pull_request:
7+
branches:
8+
- main
9+
- master
610

711
name: pkgdown
812

913
jobs:
1014
pkgdown:
11-
runs-on: macOS-latest
15+
if: ${{ github.event_name == 'push' || startsWith(github.head_ref, 'pkgdown/') }}
16+
runs-on: ubuntu-18.04
1217
env:
18+
RSPM: https://packagemanager.rstudio.com/cran/__linux__/bionic/latest
1319
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
1420
steps:
1521
- uses: actions/checkout@v2
1622

1723
- uses: r-lib/actions/setup-r@v1
24+
id: install-r
1825

1926
- uses: r-lib/actions/setup-pandoc@v1
2027

21-
- name: Query dependencies
28+
- name: Install pak and query dependencies
2229
run: |
23-
install.packages('remotes')
24-
saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
25-
writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
30+
install.packages("pak", repos = "https://r-lib.github.io/p/pak/dev/")
31+
saveRDS(pak::pkg_deps("local::.", dependencies = TRUE), ".github/r-depends.rds")
2632
shell: Rscript {0}
2733

2834
- name: Cache R packages
2935
uses: actions/cache@v2
3036
with:
3137
path: ${{ env.R_LIBS_USER }}
32-
key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}
33-
restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-
38+
key: ${{ runner.os }}-${{ steps.install-r.outputs.installed-r-version }}-1-${{ hashFiles('.github/r-depends.rds') }}
39+
restore-keys: ${{ runner.os }}-${{ steps.install-r.outputs.installed-r-version }}-1-
3440

35-
- name: Install dependencies
36-
run: remotes::install_deps(dependencies = TRUE)
41+
- name: Install system dependencies
42+
if: runner.os == 'Linux'
43+
run: |
44+
pak::local_system_requirements(execute = TRUE)
45+
pak::pkg_system_requirements("pkgdown", execute = TRUE)
46+
shell: Rscript {0}
47+
48+
- name: Install package and dependencies
49+
run: |
50+
pak::local_install_dev_deps(upgrade = TRUE)
51+
pak::pkg_install("r-lib/pkgdown")
52+
pak::pkg_install("rstudio/quillt")
3753
shell: Rscript {0}
3854

3955
- name: Install package
4056
run: R CMD INSTALL .
4157

4258
- name: Build pkgdown site
43-
run: |
44-
install.packages("pkgdown", type = "binary")
45-
pkgdown::build_site(new_process = FALSE)
59+
run: pkgdown::build_site(new_process = FALSE)
4660
shell: Rscript {0}
4761

48-
- name: Publish
49-
run: |
50-
npm install netlify-cli -g
51-
netlify deploy --prod --dir docs
62+
- name: Deploy to Netlify
63+
id: netlify-deploy
64+
uses: nwtgck/actions-netlify@v1.1
65+
with:
66+
publish-dir: 'reference'
67+
production-branch: master
68+
github-token: ${{ secrets.GITHUB_TOKEN }}
69+
deploy-message:
70+
'Deploy from GHA: ${{ github.event.head_commit.message }} (${{ github.sha }})'
71+
enable-pull-request-comment: false
72+
enable-commit-comment: false
73+
enable-commit-status: true
74+
alias: deploy-preview-${{ github.event.number }}
5275
env:
5376
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
5477
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@
55
inst/doc
66
doc
77
Meta
8+
docs

0 commit comments

Comments
 (0)