diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..a282451 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,40 @@ +name: Release + +on: + push: + tags: + - 'v*' + +permissions: + contents: write + +jobs: + release: + name: Create Release + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: Extract version from tag + id: version + run: echo "version=${GITHUB_REF_NAME#v}" >> "$GITHUB_OUTPUT" + + - name: Extract changelog entry + run: | + version="${{ steps.version.outputs.version }}" + awk -v hdr="## [$version]" \ + 'index($0,hdr)==1{found=1;next} found && /^---/{exit} found{print}' \ + CHANGELOG.md > release_notes.txt + + - name: Generate checksum + run: sha256sum worktree-functions.sh > worktree-functions.sh.sha256 + + - name: Create release + env: + GH_TOKEN: ${{ github.token }} + run: | + gh release create "$GITHUB_REF_NAME" \ + --title "$GITHUB_REF_NAME" \ + --notes-file release_notes.txt \ + worktree-functions.sh \ + worktree-functions.sh.sha256 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..3930f03 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,61 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment: + +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience +- Focusing on what is best not just for us as individuals, but for the overall community + +Examples of unacceptable behavior: + +- The use of sexualized language or imagery, and sexual attention or advances of any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic address, without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting + +## Enforcement Responsibilities + +The project maintainer is responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that is deemed inappropriate, threatening, offensive, or harmful. + +The project maintainer has the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. + +## Scope + +This Code of Conduct applies within all project spaces, including GitHub issues, pull requests, discussions, and the repository itself. It also applies when an individual is officially representing the project in public spaces, such as social media posts or conference talks. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainer at **twosliced@gmail.com**. All complaints will be reviewed and investigated promptly and fairly. + +The project maintainer is obligated to respect the privacy and security of the reporter of any incident. + +## Enforcement Guidelines + +The project maintainer will follow these guidelines in determining the consequences for any action deemed in violation of this Code of Conduct: + +**1. Correction** +A private written communication clarifying the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. + +**2. Warning** +A warning with consequences for continued behavior. No interaction with the people involved for a specified period of time. + +**3. Temporary Ban** +A temporary ban from any sort of interaction or public communication with the project for a specified period of time. + +**4. Permanent Ban** +A permanent ban from any sort of public interaction within the project community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..01a7f23 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,22 @@ +# Security Policy + +## Supported Versions + +| Version | Supported | +| ------- | --------- | +| 1.0.x | Yes | + +Older versions receive no security fixes. Please update to the latest release. + +## Reporting a Vulnerability + +**Do not open a public GitHub issue for security vulnerabilities.** + +Use [GitHub's private vulnerability reporting](https://github.com/gentbot/wrktr/security/advisories/new) to report a vulnerability confidentially. You will receive a response within 30 days ( or less ) acknowledging the report. If the issue is confirmed, a fix will be released as soon as possible and you will be credited in the changelog unless you prefer otherwise. + +Please include: + +- A description of the vulnerability and its potential impact +- Steps to reproduce or a proof-of-concept +- The version of wrktr affected +- Any suggested fix if you have one