chore: standardize repository for procore open-source

- [x] setup .github folder (actions, dependabot.yaml, ISSUE_TEMPLATES, PULL_REQUEST_TEMPLATE.md, CODEOWNERS) - [x] setup required files (README.md, SECURITY.md, CODE_OF_CONDUCT.md, LICENSE.md, CONTRIBUTING.md) - [x] update gemspec file - [x] setup postgres in tests in GitHub actions - [x] add EMERITUS mentioning former upstream contributors - [x] update LICENSE.md with previous owners - [x] setup dummy rails app in specs folder - [x] test against postgres bookworm versions Signed-off-by: jmeridth <[email protected]> Co-authored-by: Steven Johnson <[email protected]>
procore-oss · Feb 22, 2024 · 1b2dee8 · 1b2dee8
1 parent e775cf9
commit 1b2dee8
Show file tree

Hide file tree

Showing 75 changed files with 1,390 additions and 35 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1 @@
+* @procore-oss/procore-ospo
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -0,0 +1,66 @@
+name: 🐞 Bug
+description: File a bug/issue
+title: "[bug] <title>"
+labels: [bug, needs-triage]
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please search to see if an issue already exists for the bug you encountered.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: checkboxes
+  attributes:
+    label: Is this a regression?
+    description: Did this behavior work before?
+    options:
+    - label: Yes, this used to work before
+      required: false
+- type: textarea
+  attributes:
+    label: Current Behavior
+    description: A concise description of what you're experiencing.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Expected Behavior
+    description: A concise description of what you expected to happen.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Steps To Reproduce
+    description: Steps to reproduce the behavior.
+    placeholder: |
+      1.
+      2.
+      3.
+      4.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Environment
+    description: |
+      examples:
+        - **OS**: OSX 13.3.1
+        - **Browser Name and Version**: Chrome Version 112.0.5615.49 (Official Build) (arm64)
+        - **Ruby Version**: 3.0.0
+    value: |
+        - OS:
+        - Browser Name and version:
+        - Ruby Version:
+    render: markdown
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Anything else?
+    description: |
+      Links? References? Anything that will give us more context about the issue you are encountering!
+
+      Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+  validations:
+    required: false
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: false
diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/docs.yml
@@ -0,0 +1,18 @@
+name: 📚 Documentation or README.md issue report
+description: File a bug/issue for docs or README.md
+title: "[bug] <title>"
+labels: [docs, needs-triage]
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please search to see if an issue already exists for the bug you encountered.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: textarea
+  attributes:
+    label: Docs/README.md Part to update
+    description: A concise description of what you thing should be updated
+  validations:
+    required: true
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml
@@ -0,0 +1,36 @@
+name: 🚀🆕 Feature Request
+description: Suggest an idea or possible new feature for this project
+title: "[Feature Request] <title>"
+labels: [feature, needs-triage]
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please search to see if an issue already exists for the bug you encountered.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: textarea
+  attributes:
+    label: Is your feature request related to a problem? Please describe
+    description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Describe the feature you'd like to see implemented
+    description: A clear and concise description of what you want to happen
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Describe alternatives you've considered
+    description: A clear and concise description of any alternative solutions or features you've considered
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Additional context
+    description: Add any other context or additional information about the problem here
+  validations:
+    required: false
diff --git a/.github/ISSUE_TEMPLATE/question-support.yml b/.github/ISSUE_TEMPLATE/question-support.yml
@@ -0,0 +1,18 @@
+name: ❓ Question or Support Request
+description: Questions and requests for support
+title: "[Question/Support] <title>"
+labels: [question, support, needs-triage]
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please search to see if an issue already exists for the bug you encountered.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: textarea
+  attributes:
+    label: Describe your question or ask for support
+    description: A concise description of what you would like support with
+  validations:
+    required: true
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,17 @@
+Checklist:
+
+* [ ] I have updated the necessary documentation
+* [ ] I have signed off all my commits as required by [DCO](https://github.com/procore-oss/rspec_profiling/blob/main/CONTRIBUTING.md)
+* [ ] My build is green
+
+<!--
+Note on DCO:
+
+If the DCO check fails, one or more of your commits are not signed off. Please click on the *Details* link next to the DCO action for instructions on how to resolve this.
+
+TL;DR - You need to sign off your commits with `git commit -s` or `git commit --signoff` to indicate that you agree to the terms of the DCO.
+
+Note on Versioning:
+
+Maintainers will bump the version and do a release when they are ready to release (possibly multiple merged PRs). Please do not bump the version in your PRs.
+-->
diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml
@@ -0,0 +1,20 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: /
+    schedule:
+      interval: "weekly"
+      timezone: "America/Los_Angeles"
+    labels:
+      - "dependabot"
+      - "dependencies"
+      - "github-actions"
+  - package-ecosystem: "bundler"
+    directory: /
+    schedule:
+      interval: "weekly"
+      timezone: "America/Los_Angeles"
+    labels:
+      - "dependabot"
+      - "dependencies"
+      - "bundler"
diff --git a/.github/workflows/auto-assign-author.yaml b/.github/workflows/auto-assign-author.yaml
@@ -0,0 +1,13 @@
+name: 'Auto Author Assign'
+
+on:
+  pull_request_target:
+    types: [opened, reopened]
+
+jobs:
+  assign-author:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: toshimaru/[email protected]
+        with:
+          repo-token: "${{ secrets.GITHUB_TOKEN }}"
diff --git a/.github/workflows/codeql.yaml b/.github/workflows/codeql.yaml
@@ -0,0 +1,43 @@
+name: "Custom CodeQL"
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: Ubuntu-latest
+    timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v3
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3
+      with:
+        category: "/language:${{matrix.language}}"
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -0,0 +1,40 @@
+name: Release
+on:
+  workflow_run:
+    workflows: [Test]
+    types: [completed]
+    branches: [master, main]
+  workflow_dispatch: # allow manual deployment through GitHub Action UI
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Version file changed
+        id: version-file-changed
+        uses: tj-actions/changed-files@v42
+        with:
+          files: lib/blueprinter/version.rb
+      - name: Set up Ruby
+        if: ${{ github.event_name == 'workflow_dispatch' || steps.version-file-changed.outputs.any_changed == 'true' }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2
+          bundler-cache: true
+      - name: Installing dependencies
+        if: ${{ github.event_name == 'workflow_dispatch' || steps.version-file-changed.outputs.any_changed == 'true' }}
+        run: bundle check --path=vendor/bundle || bundle install --path=vendor/bundle
+      - name: Build gem file
+        if: ${{ github.event_name == 'workflow_dispatch' || steps.version-file-changed.outputs.any_changed == 'true' }}
+        run: bundle exec rake build
+      - uses: fac/ruby-gem-setup-credentials-action@v2
+        if: ${{ github.event_name == 'workflow_dispatch' || steps.version-file-changed.outputs.any_changed == 'true' }}
+        with:
+          user: ""
+          key: rubygems
+          token: ${{secrets.RUBY_GEMS_API_KEY}}
+      - uses: fac/ruby-gem-push-action@v2
+        if: ${{ github.event_name == 'workflow_dispatch' || steps.version-file-changed.outputs.any_changed == 'true' }}
+        with:
+          key: rubygems
diff --git a/.github/workflows/stale.yaml b/.github/workflows/stale.yaml
@@ -0,0 +1,38 @@
+## Reference: https://github.com/actions/stale
+name: Mark stale issues and pull requests
+on:
+  schedule:
+  - cron: "30 1 * * *"
+
+permissions:
+  contents: read
+
+jobs:
+  stale:
+    permissions:
+      issues: write  # for actions/stale to close stale issues
+      pull-requests: write  # for actions/stale to close stale PRs
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/stale@v9
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        # Number of days of inactivity before an issue becomes stale
+        days-before-stale: 60
+        # Number of days of inactivity before a stale issue is closed
+        days-before-close: 7
+        # Issues with these labels will never be considered stale
+        exempt-issue-labels: "on-hold,pinned,security"
+        exempt-pr-labels: "on-hold,pinned,security"
+        # Comment to post when marking an issue as stale.
+        stale-issue-message: >
+          This issue has been automatically marked as stale because it has not had
+          recent activity. It will be closed if no further activity occurs. Thank you
+          for your contributions.
+        stale-pr-message: >
+          This pull request has been automatically marked as stale because it has not had
+          recent activity. It will be closed if no further activity occurs. Thank you
+          for your contributions.
+        # Label to use when marking an issue as stale
+        stale-issue-label: 'no-issue-activity'
+        stale-pr-label: 'no-pr-activity'
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -0,0 +1,54 @@
+name: Test
+on:
+  push:
+    branches: [master, main]
+  pull_request:
+    branches: [master, main]
+permissions:
+  contents: read
+jobs:
+  test:
+    env:
+      ENVIRONMENT: test
+      PGDATABASE: rspec_profiling_test
+      PGHOST: localhost
+      PGPASSWORD: mypassword
+      PGUSER: myuser
+      SPEC_GEMFILE: spec/Gemfile
+    strategy:
+      matrix:
+        ruby: ['2.7', '3.0', '3.1', '3.2', '3.3']
+        postgres: ['16-bookworm', '15-bookworm', '14-bookworm', '13-bookworm', '12-bookworm']
+    name: Ruby ${{ matrix.ruby }} - PostgreSQL ${{ matrix.postgres }}
+    # https://docs.github.com/en/actions/learn-github-actions/expressions#example
+    runs-on: ${{ matrix.ruby == '2.7' && 'ubuntu-20.04' || 'ubuntu-latest' }}
+    services:
+      postgres:
+        image: postgres:${{ matrix.postgres }}
+        env:
+          POSTGRES_HOST: ${{ env.PGHOST }}
+          POSTGRES_DB: ${{ env.PGDATABASE}}
+          POSTGRES_HOST_AUTH_METHOD: trust
+          POSTGRES_USER: ${{ env.PGUSER }}
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Installing dependencies
+        run: bundle install --gemfile ${{ env.SPEC_GEMFILE }} && cd spec/dummy && bundle install
+      - name: Setup Database in Dummy Rails App
+        run: cd spec/dummy && bundle exec rake db:create db:migrate --trace RAILS_ENV=${{ env.ENVIRONMENT }}
+      - name: Initialize rspec_profiling in Dummy Rails App
+        run: cd spec/dummy && bundle exec rake rspec_profiling:install RAILS_ENV=${{ env.ENVIRONMENT }}
+      - name: Run specs
+        run: bundle exec --gemfile ${{ env.SPEC_GEMFILE }} rspec
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+.env
 .yardoc
 Gemfile.lock
 InstalledFiles
@@ -11,6 +12,7 @@ doc/
 lib/bundler/man
 pkg
 rdoc
+rspec_profiling
 spec/reports
 test/tmp
 test/version_tmp