Skip to content

Commit c0a8f64

Browse files
authored
Upkeep 2023-10 (#181)
* Rebrand * `usethis::use_tidy_coc()` * `usethis::use_mit_license()` * Bump R requirement * `usethis::use_tidy_github_actions()`
1 parent cf5a702 commit c0a8f64

9 files changed

+163
-14
lines changed

.github/CODE_OF_CONDUCT.md

+126
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
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, caste, color, religion, or sexual
10+
identity and 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 advances of
31+
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 address,
35+
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 of
42+
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 when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
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 [email protected].
63+
All complaints will be reviewed and investigated promptly and fairly.
64+
65+
All community leaders are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series of
85+
actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interactions in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or permanent
92+
ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within the
112+
community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117+
version 2.1, available at
118+
<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
119+
120+
Community Impact Guidelines were inspired by
121+
[Mozilla's code of conduct enforcement ladder][https://github.com/mozilla/inclusion].
122+
123+
For answers to common questions about this code of conduct, see the FAQ at
124+
<https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.
125+
126+
[homepage]: https://www.contributor-covenant.org

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

+4-2
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,13 @@ jobs:
2222
fail-fast: false
2323
matrix:
2424
config:
25-
- {os: macOS-latest, r: 'release'}
25+
- {os: macos-latest, r: 'release'}
2626

2727
- {os: windows-latest, r: 'release'}
2828
# Use 3.6 to trigger usage of RTools35
2929
- {os: windows-latest, r: '3.6'}
30+
# use 4.1 to check with rtools40's older compiler
31+
- {os: windows-latest, r: '4.1'}
3032

3133
- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'}
3234
- {os: ubuntu-latest, r: 'release'}
@@ -40,7 +42,7 @@ jobs:
4042
R_KEEP_PKG_SOURCE: yes
4143

4244
steps:
43-
- uses: actions/checkout@v2
45+
- uses: actions/checkout@v3
4446

4547
- uses: r-lib/actions/setup-pandoc@v2
4648

.github/workflows/pkgdown.yaml

+4-2
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,10 @@ jobs:
1919
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
2020
env:
2121
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
22+
permissions:
23+
contents: write
2224
steps:
23-
- uses: actions/checkout@v2
25+
- uses: actions/checkout@v3
2426

2527
- uses: r-lib/actions/setup-pandoc@v2
2628

@@ -39,7 +41,7 @@ jobs:
3941

4042
- name: Deploy to GitHub pages 🚀
4143
if: github.event_name != 'pull_request'
42-
uses: JamesIves/[email protected].4
44+
uses: JamesIves/github-pages-deploy-action@v4.4.1
4345
with:
4446
clean: false
4547
branch: gh-pages

.github/workflows/pr-commands.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
env:
1515
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
1616
steps:
17-
- uses: actions/checkout@v2
17+
- uses: actions/checkout@v3
1818

1919
- uses: r-lib/actions/pr-fetch@v2
2020
with:
@@ -51,7 +51,7 @@ jobs:
5151
env:
5252
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
5353
steps:
54-
- uses: actions/checkout@v2
54+
- uses: actions/checkout@v3
5555

5656
- uses: r-lib/actions/pr-fetch@v2
5757
with:

.github/workflows/test-coverage.yaml

+21-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
1616

1717
steps:
18-
- uses: actions/checkout@v2
18+
- uses: actions/checkout@v3
1919

2020
- uses: r-lib/actions/setup-r@v2
2121
with:
@@ -27,5 +27,24 @@ jobs:
2727
needs: coverage
2828

2929
- name: Test coverage
30-
run: covr::codecov(quiet = FALSE)
30+
run: |
31+
covr::codecov(
32+
quiet = FALSE,
33+
clean = FALSE,
34+
install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package")
35+
)
3136
shell: Rscript {0}
37+
38+
- name: Show testthat output
39+
if: always()
40+
run: |
41+
## --------------------------------------------------------------------
42+
find ${{ runner.temp }}/package -name 'testthat.Rout*' -exec cat '{}' \; || true
43+
shell: bash
44+
45+
- name: Upload test results
46+
if: failure()
47+
uses: actions/upload-artifact@v3
48+
with:
49+
name: coverage-test-failures
50+
path: ${{ runner.temp }}/package

DESCRIPTION

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Title: Syntax Highlighting and Automatic Linking
33
Version: 0.4.3.9000
44
Authors@R: c(
55
person("Hadley", "Wickham", , "[email protected]", role = c("aut", "cre")),
6-
person("RStudio", role = c("cph", "fnd"))
6+
person("Posit Software, PBC", role = c("cph", "fnd"))
77
)
88
Description: Syntax highlighting of R code, specifically designed for the
99
needs of 'RMarkdown' packages like 'pkgdown', 'hugodown', and
@@ -14,7 +14,7 @@ License: MIT + file LICENSE
1414
URL: https://downlit.r-lib.org/, https://github.com/r-lib/downlit
1515
BugReports: https://github.com/r-lib/downlit/issues
1616
Depends:
17-
R (>= 3.4.0)
17+
R (>= 3.6)
1818
Imports:
1919
brio,
2020
desc,

LICENSE

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
YEAR: 2020
2-
COPYRIGHT HOLDER: RStudio
1+
YEAR: 2023
2+
COPYRIGHT HOLDER: downlit authors

LICENSE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MIT License
22

3-
Copyright (c) 2020 RStudio
3+
Copyright (c) 2023 downlit authors
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

man/downlit-package.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)