Skip to content

Commit fc2a409

Browse files
authored
chore(docs): add SECURITY.md and textlint setup for development consistency (#15)
* docs: add SECURITY.md to outline security practices and best practices - Added a SECURITY.md file to establish security guidelines and best practices for the Terraform Module Releaser GitHub Action. - Included reporting guidelines for non-confidential and confidential vulnerabilities. - Recommended best practices like reviewing CodeQL results, pinning to the latest major version (e.g., v1), and using least privilege permissions. - Added resources for further security documentation. Resolves issue #11 * chore: add textlint dev dependencies and package.json script for local testing - Added textlint and related development dependencies to facilitate local testing of textlint rules. - Created a `textlint` script in package.json to allow developers to run textlint checks locally before pushing changes. - Helps ensure consistency with textlint rules that are enforced in CI.
1 parent 267e544 commit fc2a409

File tree

4 files changed

+2611
-102
lines changed

4 files changed

+2611
-102
lines changed

.github/linters/.textlintrc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"plugins": {},
3+
"filters": {
4+
"comments": true
5+
},
6+
"rules": {
7+
"terminology": true
8+
}
9+
}

SECURITY.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Security Policy
2+
3+
**[Terraform Module Releaser](https://github.com/techpivot/terraform-module-releaser)** takes security seriously. We are
4+
committed to protecting the integrity of your infrastructure and adhering to secure coding practices.
5+
6+
We regularly scan for vulnerabilities using
7+
[CodeQL](https://github.com/techpivot/terraform-module-releaser/actions/workflows/codeql-analysis.yml). The results are
8+
public and available for review.
9+
10+
## Reporting a Vulnerability
11+
12+
If you discover a security issue in the `Terraform Module Releaser`, please adhere to the following reporting
13+
guidelines:
14+
15+
### Reporting Guidelines
16+
17+
**Non-Confidential Issues**: [Open an issue](https://github.com/techpivot/terraform-module-releaser/issues/new/choose)
18+
directly on the GitHub repository with a detailed description of the vulnerability, including steps to reproduce if
19+
possible.
20+
21+
**Confidential or High-Priority Issues**: Report sensitive vulnerabilities directly to our security team at
22+
<[email protected]>. We aim to respond within 24 hours.
23+
24+
## Best Practices
25+
26+
This GitHub Action runs inside a GitHub Actions runner and may have access to the source control repository. To minimize
27+
security risks, we recommend the following practices when using this Action:
28+
29+
- Review the CodeQL analysis results regularly to ensure the code remains free of known vulnerabilities.
30+
- **Pin to the latest major version** (e.g., `v1`) instead of an explicit version tag. This ensures you benefit from the
31+
latest features, security patches, and bugfixes while maintaining backward compatibility.
32+
- Please refer to the
33+
[permissions in the README.md](https://github.com/techpivot/terraform-module-releaser?tab=readme-ov-file#permissions)
34+
to ensure that the required GitHub Action permissions are set appropriately with **least privilege**.
35+
- Regularly update to the latest version of the Action to benefit from any security fixes.
36+
- **Audit GitHub Actions dependencies** regularly to ensure that no third-party actions have introduced vulnerabilities
37+
or insecure behaviors.
38+
39+
## Resources
40+
41+
- [GitHub Actions Security Best Practices](https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions)
42+
- [Terraform Module Releaser CodeQL Analysis](https://github.com/techpivot/terraform-module-releaser/actions/workflows/codeql-analysis.yml)

0 commit comments

Comments
 (0)