From 1d3c64f5fad047f3d6d79714738a585a9778d977 Mon Sep 17 00:00:00 2001 From: Soham Jaiswal Date: Sun, 5 May 2024 11:16:24 +0530 Subject: [PATCH] feat: add github files --- .github/CODEOWNERS | 1 + .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++ .../feature_pull_request.md | 34 +++++++++++++++++ .github/dependabot.yml | 12 ++++++ .github/workflows/main.yml | 31 +++++++++++++++ 6 files changed, 136 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/feature_pull_request.md create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/main.yml diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..18dca0e --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @sohamjaiswal @sosweetham \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/PULL_REQUEST_TEMPLATE/feature_pull_request.md b/.github/PULL_REQUEST_TEMPLATE/feature_pull_request.md new file mode 100644 index 0000000..cb023dd --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/feature_pull_request.md @@ -0,0 +1,34 @@ +## Feature Description +Please provide a brief description of the new feature being implemented in this pull request. + +## Problem Statement +Explain the problem or need that this feature aims to address. + +## Proposed Solution +Describe the solution or approach taken to implement the new feature. + +## Implementation Details +Provide additional details about the implementation, such as specific code changes, new components, or relevant architectural decisions. + +## Screenshots (if applicable) +If the feature introduces changes to the UI, include screenshots or images showcasing the new functionality. + +## Testing +Describe the steps taken to test the feature. Include relevant test cases or scenarios that were considered. + +## Dependencies +List any dependencies or related issues/pull requests that need to be resolved for this feature to work correctly. + +## Checklist +- [ ] I have tested this feature locally and it works as expected. +- [ ] I have updated the documentation, if necessary, to reflect the new feature. +- [ ] I have followed the project's coding standards and best practices. +- [ ] I have reviewed my code and ensured it is well-documented and maintainable. +- [ ] I have assigned the pull request to the appropriate reviewer(s). + +## Related Issues +List any related issues or pull requests that are connected to this feature. + +## Additional Notes +Add any additional information or context that might be helpful for reviewers. + diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..d7b2b2e --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,12 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + - package-ecosystem: "npm" # See documentation for possible values + directory: "/" # Location of package manifests + schedule: + interval: "weekly" + diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..43cd223 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,31 @@ +name: Deploy + +# Controls when the action will run. +on: + # Triggers the workflow on push or pull request events but only for the master branch + push: + branches: [ main ] + workflow_dispatch: + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + # This workflow contains a single job called "build" + build: + # The type of runner that the job will run on + runs-on: ubuntu-latest + + # Steps represent a sequence of tasks that will be executed as part of the job + steps: + - name: Deploy using ssh + uses: appleboy/ssh-action@master + with: + host: ${{ secrets.HOST }} + username: ${{ secrets.USERNAME }} + key: ${{ secrets.SSH_PRIVATE_KEY }} + port: 22 + script: | + cd ~/PhotoBox + git pull origin main + docker-compose down --remove-orphans + docker-compose up --build -d +