Skip to content

Commit

Permalink
chore: add semantic release control resources
Browse files Browse the repository at this point in the history
  • Loading branch information
lpm0073 committed Jan 3, 2024
1 parent 3b8f096 commit d16ea93
Show file tree
Hide file tree
Showing 20 changed files with 8,357 additions and 3 deletions.
27 changes: 27 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Contributing

This repository is released under the Apache License 2.0, and follows a standard GitHub development process. We use the GitHub tracker for issues and merge pull requests into the main branch.

## Project Structure

The project consists of a serverless backend written in Terraform for AWS, and a frontend written in ReactJS.

## How to Contribute

1. **Fork the Repository**: Start by forking the repository and then clone it locally.

2. **Create a Branch**: Create a new branch for each issue you're working on. Having a separate branch for each issue makes it easier to track changes and enables us to review your changes more effectively.

3. **Make Your Changes**: Make your changes in your branch. Be sure to test your changes!

4. **Commit Your Changes**: Commit your changes regularly and write commit messages that follow [these Conventional Commits guidelines](../SEMANTIC_VERSIONING.md). This will make it easier for us to follow your progress and understand what each commit does.

5. **Push Your Changes**: Push your changes to your fork on GitHub.

6. **Submit a Pull Request**: Once you're happy with your changes and you've pushed them to GitHub, you can create a pull request. We'll review your pull request and, if everything looks good, merge it into the main branch.

## Code of Conduct

We expect all contributors to follow our code of conduct. Please read our [Code of Conduct](../CODE_OF_CONDUCT.md) for details.

Thank you for considering contributing to our project!
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# These are supported funding model platforms

github: lpm0073
patreon: FullStackWithLawrence
patreon: lpm0073
78 changes: 78 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG-REPORT.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
name: "🐛 Bug Report"
description: Create a new ticket for a bug.
title: "🐛 [BUG] - <title>"
labels: ["bug"]
body:
- type: textarea
id: description
attributes:
label: "Description"
description: Please enter an explicit description of your issue
placeholder: Short and explicit description of your incident...
validations:
required: true
- type: input
id: reprod-url
attributes:
label: "Reproduction URL"
description: Please enter your GitHub URL to provide a reproduction of the issue
placeholder: ex. https://github.com/USERNAME/REPO-NAME
validations:
required: true
- type: textarea
id: reprod
attributes:
label: "Reproduction steps"
description: Please enter an explicit description of your issue
value: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
render: bash
validations:
required: true
- type: textarea
id: screenshot
attributes:
label: "Screenshots"
description: If applicable, add screenshots to help explain your problem.
value: |
![DESCRIPTION](LINK.png)
render: bash
validations:
required: false
- type: textarea
id: logs
attributes:
label: "Logs"
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: bash
validations:
required: false
- type: dropdown
id: browsers
attributes:
label: "Browsers"
description: What browsers are you seeing the problem on ?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- Opera
validations:
required: false
- type: dropdown
id: os
attributes:
label: "OS"
description: What is the impacted environment ?
multiple: true
options:
- Windows
- Linux
- Mac
validations:
required: false
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: "💡 Feature Request"
description: Create a new ticket for a new feature request
title: "💡 [REQUEST] - <title>"
labels: ["question"]
body:
- type: input
id: start_date
attributes:
label: "Start Date"
description: Start of development
placeholder: "month/day/year"
validations:
required: false
- type: textarea
id: implementation_pr
attributes:
label: "Implementation PR"
description: Pull request used
placeholder: "#Pull Request ID"
validations:
required: false
- type: textarea
id: reference_issues
attributes:
label: "Reference Issues"
description: Common issues
placeholder: "#Issues IDs"
validations:
required: false
- type: textarea
id: summary
attributes:
label: "Summary"
description: Provide a brief explanation of the feature
placeholder: Describe in a few lines your feature request
validations:
required: true
- type: textarea
id: basic_example
attributes:
label: "Basic Example"
description: Indicate here some basic examples of your feature.
placeholder: A few specific words about your feature request.
validations:
required: true
- type: textarea
id: drawbacks
attributes:
label: "Drawbacks"
description: What are the drawbacks/impacts of your feature request ?
placeholder: Identify the drawbacks and impacts while being neutral on your feature request
validations:
required: true
- type: textarea
id: unresolved_question
attributes:
label: "Unresolved questions"
description: What questions still remain unresolved ?
placeholder: Identify any unresolved issues.
validations:
required: false
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
45 changes: 45 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Pull Request Template

## Type of Change

<!-- What type of change does your code introduce? -->

- [ ] New feature
- [ ] Bug fix
- [ ] Documentation
- [ ] Refactor
- [ ] Chore

## Resolves

- Fixes #[Add issue number here.]

## Changes

<!-- Describe your changes in detail, if applicable. -->

_Describe what this Pull Request does_

## Testing

<!-- Describe how the changes can be tested -->

_Describe the testing that has been done or needs to be done_

## Screenshots

<!-- If applicable, add screenshots to help explain your changes -->

_Add any relevant screenshots_

## Dependencies

<!-- List any dependencies that are required for this change -->

_List dependencies_

## Breaking Changes

<!-- Does this PR contain any breaking changes? -->

_Describe any breaking changes_
59 changes: 59 additions & 0 deletions .github/actions/merge-branch/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
#------------------------------------------------------------------------------
# Run pre-commit
#------------------------------------------------------------------------------
name: Merge
branding:
icon: "git-pull-request"
color: "orange"
inputs:
github-token:
description: "The GitHub token to use for authentication"
required: true
type: string
source-branch:
description: "The branch to merge from"
required: false
type: string
default: "main"
target-branch:
description: "The branch to merge to"
required: true
type: string

python-version:
description: "The version of Python to use, such as 3.11.0"
required: true
type: string

runs:
using: "composite"
steps:
- name: Checkout code
id: checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
persist-credentials: false

- name: Remember current branch
shell: bash
run: |
echo "CURRENT_BRANCH=$(git branch --show-current)" >> $GITHUB_ENV
- name: Merge
id: merge
shell: bash
run: |
git config --local user.email "[email protected]"
git config --local user.name "GitHub Action"
git checkout ${{ inputs.source-branch }}
git pull
git checkout ${{ inputs.target-branch }}
git merge -Xtheirs ${{ inputs.source-branch }}
git push https://${{ inputs.github-token }}@github.com/${{ github.repository }}.git HEAD:${{ inputs.target-branch }}
- name: Checkout current branch
shell: bash
run: |
git checkout ${{ env.CURRENT_BRANCH }}
73 changes: 73 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
version: 2
updates:
- package-ecosystem: "terraform"
directory: "/api/terraform/"
schedule:
interval: "weekly"
open-pull-requests-limit: 10
labels:
- "dependencies"
- "automated pr"
assignees:
- "lpm0073"
reviewers:
- "lpm0073"
- package-ecosystem: "pip"
directory: "/api/terraform/python/layer_genai/"
schedule:
interval: "weekly"
labels:
- "dependencies"
- "python"
- "automated pr"
assignees:
- "lpm0073"
reviewers:
- "lpm0073"
- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "weekly"
labels:
- "dependencies"
- "python"
- "automated pr"
assignees:
- "lpm0073"
reviewers:
- "lpm0073"
- package-ecosystem: "npm"
directory: "/client"
labels:
- "dependencies"
- "javascript"
- "automated pr"
schedule:
interval: "weekly"
assignees:
- "lpm0073"
reviewers:
- "lpm0073"
- package-ecosystem: "npm"
directory: "/"
labels:
- "dependencies"
- "javascript"
- "automated pr"
schedule:
interval: "weekly"
assignees:
- "lpm0073"
reviewers:
- "lpm0073"
- package-ecosystem: "github-actions"
directory: "/"
labels:
- "dependencies"
- "automated pr"
schedule:
interval: "weekly"
assignees:
- "lpm0073"
reviewers:
- "lpm0073"
19 changes: 19 additions & 0 deletions .github/workflows/auto-assign.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Auto Assign
on:
issues:
types: [opened]
pull_request:
types: [opened]
jobs:
run:
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- name: "Auto-assign issue"
uses: pozil/auto-assign-issue@v1
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
assignees: lpm0073
numOfAssignee: 1
Loading

0 comments on commit d16ea93

Please sign in to comment.