Skip to content

Commit 9fc29cd

Browse files
authored
Merge pull request #161 from kjd/master
Resync with recent contributions
2 parents 0166089 + acb8c4a commit 9fc29cd

File tree

2 files changed

+65
-5
lines changed

2 files changed

+65
-5
lines changed

.github/workflows/scorecard.yml

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Scorecard supply-chain security
2+
on:
3+
# For Branch-Protection check. Only the default branch is supported. See
4+
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
5+
branch_protection_rule:
6+
# To guarantee Maintained check is occasionally updated. See
7+
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
8+
schedule:
9+
- cron: '37 3 * * 4'
10+
push:
11+
branches: [ "master" ]
12+
13+
# Declare default permissions as read only.
14+
permissions: read-all
15+
16+
jobs:
17+
analysis:
18+
name: Scorecard analysis
19+
runs-on: ubuntu-latest
20+
permissions:
21+
# Needed to upload the results to code-scanning dashboard.
22+
security-events: write
23+
# Needed to publish results and get a badge (see publish_results below).
24+
id-token: write
25+
26+
steps:
27+
- name: "Checkout code"
28+
uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # v3.1.0
29+
with:
30+
persist-credentials: false
31+
32+
- name: "Run analysis"
33+
uses: ossf/scorecard-action@e38b1902ae4f44df626f11ba0734b14fb91f8f86 # v2.1.2
34+
with:
35+
results_file: results.sarif
36+
results_format: sarif
37+
# (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
38+
# - you want to enable the Branch-Protection check without using the new GitHub Repos(which are public by default): https://github.blog/2023-07-24-github-repository-rules-are-now-generally-available/
39+
# To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat.
40+
# repo_token: ${{ secrets.SCORECARD_TOKEN }}
41+
42+
# - Publish results to OpenSSF REST API for easy access by consumers
43+
# - Allows the repository to include the Scorecard badge.
44+
# - See https://github.com/ossf/scorecard-action#publishing-results.
45+
publish_results: true
46+
47+
# Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
48+
# format to the repository Actions tab.
49+
- name: "Upload artifact"
50+
uses: actions/upload-artifact@3cea5372237819ed00197afe530f5a7ea3e805c8 # v3.1.0
51+
with:
52+
name: SARIF file
53+
path: results.sarif
54+
retention-days: 5
55+
56+
# Upload the results to GitHub's code scanning dashboard.
57+
- name: "Upload to code-scanning"
58+
uses: github/codeql-action/upload-sarif@17573ee1cc1b9d061760f3a006fc4aac4f944fd5 # v2.2.4
59+
with:
60+
sarif_file: results.sarif

README.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ IDNA specification this conversion is not performed.
112112
>>> idna.encode('Königsgäßchen', uts46=True, transitional=True)
113113
'xn--knigsgsschen-lcb0w'
114114
115-
Implementors should use transitional processing with caution, only in
115+
Implementers should use transitional processing with caution, only in
116116
rare cases where conversion from legacy labels to current labels must be
117117
performed (i.e. IDNA implementations that pre-date 2008). For typical
118118
applications that just need to convert labels, transitional processing
@@ -155,8 +155,8 @@ and perform the required calculations to identify eligibility. There are
155155
three main modes:
156156

157157
* ``idna-data make-libdata``. Generates ``idnadata.py`` and
158-
``uts46data.py``, the pre-calculated lookup tables using for IDNA and
159-
UTS 46 conversions. Implementors who wish to track this library against
158+
``uts46data.py``, the pre-calculated lookup tables used for IDNA and
159+
UTS 46 conversions. Implementers who wish to track this library against
160160
a different Unicode version may use this tool to manually generate a
161161
different version of the ``idnadata.py`` and ``uts46data.py`` files.
162162

@@ -172,7 +172,7 @@ three main modes:
172172

173173
The tool accepts a number of arguments, described using ``idna-data
174174
-h``. Most notably, the ``--version`` argument allows the specification
175-
of the version of Unicode to use in computing the table data. For
175+
of the version of Unicode to be used in computing the table data. For
176176
example, ``idna-data --version 9.0.0 make-libdata`` will generate
177177
library data against Unicode 9.0.0.
178178

@@ -186,7 +186,7 @@ Additional Notes
186186
* **Version support**. This library supports Python 3.5 and higher.
187187
As this library serves as a low-level toolkit for a variety of
188188
applications, many of which strive for broad compatibility with older
189-
Python versions, there is no rush to remove older intepreter support.
189+
Python versions, there is no rush to remove older interpreter support.
190190
Removing support for older versions should be well justified in that the
191191
maintenance burden has become too high.
192192

0 commit comments

Comments
 (0)