Skip to content

Commit 4593e7c

Browse files
committed
doc(readme): cicd workflows
1 parent ddebd4c commit 4593e7c

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,11 +87,9 @@ if errors are found.
8787
Updates to this repository are posted as soon as they are posted to history.state.gov. Releases will
8888
include fixes to already published volumes, new publications, and digitized legacy volumes.
8989

90-
### Versioning
90+
### Versioning and Testing
9191

92-
Releases for this data package are automated. Any commit to the `master`` branch will trigger the release automation.
93-
94-
All commit message must conform to [Conventional Commit Messages](https://www.conventionalcommits.org/en/v1.0.0/) to determine semantic versioning of releases, please adhere to these conventions, like so:
92+
Releases for this data package are automated. Any commit to the `master` branch will trigger the release automation. For this automation to work, all commit message must conform to [Conventional Commit Messages](https://www.conventionalcommits.org/en/v1.0.0/) to determine semantic versioning of releases, please adhere to these conventions, like so:
9593

9694
| Commit message | Release type |
9795
|-----------------|--------------|
@@ -101,6 +99,10 @@ All commit message must conform to [Conventional Commit Messages](https://www.co
10199

102100
When opening PRs commit messages are checked using commitlint.
103101

102+
Tables of Contents inside `frus-toc` and helper files for caching inside `.last-modified` are automatically generated on CI during pull requests only. Should there be a need, the effective commands can be found in the workflow files.
103+
104+
Pull requests from external forks must enable the `allow edits by maintainers` flag when opening pull request. The presence of the flag is checked in `pr-dispatch.yml` .
105+
104106
## Feedback
105107

106108
We welcome your feedback about this repository and how we can improve it. Please submit an issue or email us

0 commit comments

Comments
 (0)