From fa824b0746ad9b24d5d80efca51484de419f561f Mon Sep 17 00:00:00 2001 From: Luqman Date: Tue, 10 Jan 2023 16:53:21 +0100 Subject: [PATCH] Feature/gitflow (#3921) * testing gitflow * Name changes * Testing python changes * Added Checkout to Base test * More minor fixes for merge * Minor fix * Added nightly build * Testing Merge * Merge error fix * Merge fix * merge fix * Merge fix * Merge fix * Merge fix * merge fix * [Gitflow] - Minor fix * Feature/gitflow (#3914) (#3915) * testing gitflow * Name changes * Testing python changes * Added Checkout to Base test * More minor fixes for merge * Minor fix * Added nightly build * Testing Merge * Merge error fix * Merge fix * merge fix * Merge fix * Merge fix * Merge fix * merge fix * [Gitflow] - Minor fix * Nightly build feature * Added branch name docs --- .github/workflows/nightly-build.yml | 11 +++++++---- CONTRIBUTING.md | 8 ++++++++ 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/.github/workflows/nightly-build.yml b/.github/workflows/nightly-build.yml index c673750478d..49c3913a44d 100644 --- a/.github/workflows/nightly-build.yml +++ b/.github/workflows/nightly-build.yml @@ -1,4 +1,4 @@ -name: Nightly Build +name: Nightly Build on the develop branch env: OPENBB_ENABLE_QUICK_EXIT: true @@ -9,9 +9,8 @@ env: PYTHONNOUSERSITE: 1 on: - workflow_dispatch: - # schedule: - # - cron: "0 0 * * *" + schedule: + - cron: "0 0 * * *" concurrency: group: ${{ github.workflow }}-${{ github.ref }} @@ -27,8 +26,12 @@ jobs: run: | Set-ItemProperty 'HKLM:\System\CurrentControlSet\Control\FileSystem' -Name 'LongPathsEnabled' -value 1 git config --system core.longpaths true + - name: Checkout uses: actions/checkout@v2.4.2 + with: + ref: develop + - name: Activate Base & Create OpenBB Environment run: | conda activate base diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bf1094ee342..ff30966ee2a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1529,6 +1529,14 @@ Network model. these get linked. Note: If you installed pre-commit hooks and one of the formatters re-formats your code, you'll need to go back to step 3 to add these. +### Branch Naming Conventions +The accepted branch naming conventions are: + +- `feature/feature-name` +- `hotfix/hotfix-name` +- `release/2.1.0` or `release/2.1.0rc0`. + +All `feature/feature-name` related branches can only have PRs pointing to `develop` branch. `hotfix/hotfix-name` and `release/2.1.0` or `release/2.1.0rc0` branches can only have PRs pointing to `main` branch. ## Add a Test Unit tests minimize errors in code and quickly find errors when they do arise. Integration tests are standard usage examples, which are also used to identify errors.